This project is designed to streamline the initial setup process for building and creating mods in the SPT-AKI environment. Follow this guide to set up your environment efficiently.
- NodeJS Setup
- IDE Setup
- Workspace Configuration
- Environment Setup
- Essential Concepts
- Coding Guidelines
- Distribution Guidelines
Before you begin, ensure to install NodeJS version v18.15.0, which has been tested thoroughly with our mod templates and build scripts. Download it from the official NodeJS website.
After installation, it's advised to reboot your system.
For this project, you can work with either VSCodium or VSCode. However, we strongly recommend using VSCode, as all development and testing have been carried out using this IDE, ensuring a smoother experience and compatibility with the project setups. Either way, we have a prepared a workspace file to assist you in setting up your environment.
With NodeJS and your chosen IDE ready, initiate the mod.code-workspace file using your IDE:
File -> Open Workspace from File...
Upon project loading, consider installing recommended plugins like the ESLint plugin.
An automated task is available to configure your environment for Typescript utilization:
Terminal -> Run Task... -> Show All Tasks... -> npm: install
Note: Preserve the node_modules folder as it contains necessary dependencies for Typescript and other functionalities.
Prioritize understanding Dependency Injection and Inversion of Control, the architectural principles SPT-AKI adopts. Comprehensive guidelines will be available on the hub upon release.
Some resources to get you started:
Focus your mod development around the mod.ts file. In the package.json file, only alter these properties: "name", "version", "license", "author", and "akiVersion".
New to Typescript? Find comprehensive documentation on the official website.
Automated tasks are set up to bundle all necessary files for your mod to function in SPT-AKI:
Terminal -> Run Task... -> Show All Tasks... -> npm: build
The ZIP output, located in the dist directory, contains all required files. Ensure all files are included and modify the .buildignore file as needed. This ZIP file is your uploadable asset for the hub.
With this setup, you're ready to begin modding with SPT-AKI. If you run into any trouble be sure to check out the modding documentation on the hub. If you really get stuck feel free to join us in the #mods-development official Discord channel.
Build something awesome!