From 0a4437b12a2b20b1ad4e6622534b28f2856575bd Mon Sep 17 00:00:00 2001 From: Chomp Date: Wed, 25 May 2022 09:10:25 +0100 Subject: [PATCH] readme formatting changes --- TypeScript/1LogToConsole/README.md | 33 +++++++++++++++++++++++------ TypeScript/5ReplaceMethod/README.md | 33 +++++++++++++++++++++++------ 2 files changed, 52 insertions(+), 14 deletions(-) diff --git a/TypeScript/1LogToConsole/README.md b/TypeScript/1LogToConsole/README.md index 560ae68..efc31a4 100644 --- a/TypeScript/1LogToConsole/README.md +++ b/TypeScript/1LogToConsole/README.md @@ -1,45 +1,64 @@ This project was created to automate most parts of building and setting up an environment. -**NodeJS 14.15.3:** +## **NodeJS 14.15.3:** + The first step would be to install nodejs on your pc, the version you NEED is **14.15.3** + That version is the one that has been used to test the mod templates and build scripts. + It can be downloaded from here: https://nodejs.org/download/release/v14.15.3/ + A system reboot may be needed after install. -**IDE:** +## **IDE:** + The second step is having an IDE ready. For the currect purpose we've setup a VSCodium workspace file. + You CAN use Visual Studio Code if you so desire, just keep in mind that our dev tests on the mod files was done using VSCodium. + You can get VSCodium here: https://vscodium.com/#install -**Workspace:** +## **Workspace:** + Once you have NodeJS and VSCodium ready, open the mod.code-workspace file with VSCodium (File->Open Worspace from File...). + Once the project loads into VSCodium you will be recommended to install the ESLint plugin. This is HIGHLY recommended. -**Environment Setup:** +## **Environment Setup:** + There is a task that will automatically setup your environment to use typescript. + To run it, you just need to go to: > Terminal->Run Task...->Show All Tasks...->npm: install After running this task, your environment will be ready to start coding. + DO NOT remove the node_modules folder, this is an auto generated directory that has the required dependencies to be able to use typescript and more. -**IMPORTANT:** +## **IMPORTANT:** + Before starting to work on your mod, we suggest you read about Dependency Injection and Inversion of Control as this is the adopted architecture SPT-AKI has adopted. + It will be difficult to understand some of the problems you may be having if you dont understand the basics of it. + A guide explaining all the essentials will be available on the hub on release for you to read about. -**Coding:** +## **Coding:** + All your work should be centered around the mod.ts file as an entry point. You can ONLY change the following properties from the package.json file: `"name"`, `"version"`, `"license"`: `"MIT"`, `"author"`, `"akiVersion"`. + If you have never used typescript before, you can read about it here: https://www.typescriptlang.org/docs/ -**Distributing your mod:** +## **Distributing your mod:** + The project has been set up with an automatic task that will copy and zip ALL required files for your mod to work on SPT-AKI. To run this task you just need to go to: > Terminal->Run Task...->Show All Tasks...->npm: build:zip The output will be a mod.zip file that will appear on the root of the project. + Always verify that all files were included into the zip file. \ No newline at end of file diff --git a/TypeScript/5ReplaceMethod/README.md b/TypeScript/5ReplaceMethod/README.md index 560ae68..efc31a4 100644 --- a/TypeScript/5ReplaceMethod/README.md +++ b/TypeScript/5ReplaceMethod/README.md @@ -1,45 +1,64 @@ This project was created to automate most parts of building and setting up an environment. -**NodeJS 14.15.3:** +## **NodeJS 14.15.3:** + The first step would be to install nodejs on your pc, the version you NEED is **14.15.3** + That version is the one that has been used to test the mod templates and build scripts. + It can be downloaded from here: https://nodejs.org/download/release/v14.15.3/ + A system reboot may be needed after install. -**IDE:** +## **IDE:** + The second step is having an IDE ready. For the currect purpose we've setup a VSCodium workspace file. + You CAN use Visual Studio Code if you so desire, just keep in mind that our dev tests on the mod files was done using VSCodium. + You can get VSCodium here: https://vscodium.com/#install -**Workspace:** +## **Workspace:** + Once you have NodeJS and VSCodium ready, open the mod.code-workspace file with VSCodium (File->Open Worspace from File...). + Once the project loads into VSCodium you will be recommended to install the ESLint plugin. This is HIGHLY recommended. -**Environment Setup:** +## **Environment Setup:** + There is a task that will automatically setup your environment to use typescript. + To run it, you just need to go to: > Terminal->Run Task...->Show All Tasks...->npm: install After running this task, your environment will be ready to start coding. + DO NOT remove the node_modules folder, this is an auto generated directory that has the required dependencies to be able to use typescript and more. -**IMPORTANT:** +## **IMPORTANT:** + Before starting to work on your mod, we suggest you read about Dependency Injection and Inversion of Control as this is the adopted architecture SPT-AKI has adopted. + It will be difficult to understand some of the problems you may be having if you dont understand the basics of it. + A guide explaining all the essentials will be available on the hub on release for you to read about. -**Coding:** +## **Coding:** + All your work should be centered around the mod.ts file as an entry point. You can ONLY change the following properties from the package.json file: `"name"`, `"version"`, `"license"`: `"MIT"`, `"author"`, `"akiVersion"`. + If you have never used typescript before, you can read about it here: https://www.typescriptlang.org/docs/ -**Distributing your mod:** +## **Distributing your mod:** + The project has been set up with an automatic task that will copy and zip ALL required files for your mod to work on SPT-AKI. To run this task you just need to go to: > Terminal->Run Task...->Show All Tasks...->npm: build:zip The output will be a mod.zip file that will appear on the root of the project. + Always verify that all files were included into the zip file. \ No newline at end of file