prepare v4.0.0 release

This commit is contained in:
hizumi
2024-02-07 23:25:23 -06:00
parent 8283f19b77
commit e372563e58
3 changed files with 45 additions and 11 deletions

View File

@@ -20,7 +20,7 @@ Once copied, the final structure should appear similar to the following:
├── mission.sqm
```
If you're building a mission for use in an op, please delete "aaFrameworkUtils" and "framework\x". These are for the purposes of development and add size bloat to the mission download when players connect to your mission.
> **Note:** If you're building a mission for use and not actively developing code, the `aaFrameworkUtils` and `framework\x` directories **should be deleted**. *These are for the purposes of development and add size bloat to the mission download when players connect to your mission.*
After the requisite configuration file edits have been made, your mission is ready to be packed into a pbo for deployment.
@@ -45,6 +45,14 @@ The contents of the lower half of the file are where the mission maker is able t
This file will be displayed the client mission loading screen.
File should remain small *(under 300KiB)* and should optimally be `1024px by 512px` in resolution
## defines/
This directory contains the definition files use by the framework in various places. *Contents should not be edited*
## framework/
This directory contains the code for the mission framework. **Contents must not be edited.**
## images/
This directory is for organizational purposes for any images you wish to use in your mission
@@ -63,7 +71,8 @@ This directory is for organizational purposes for any custom scripts you wish to
This directory is for organizational purposes for textures files used by mission scripts.
## DEV NOTES
# Development Notes
All modules are broken apart as such in /framework. Client and server inits are managed in /framework/init.