diff --git a/README.md b/README.md index c0a87fbb..06976858 100644 --- a/README.md +++ b/README.md @@ -22,34 +22,17 @@

ExpGaming Scenario Repository

-#### Using The Core Files -1. Copy the core folder and the StdLib File -2. Copy the control.lua and edit the load.lua in each file -3. The require order is important in the control.lua -4. Use playerRanks.lua to edit the rank system -5. Add your own files to the addons folder and require them in the load.lua +#### Use and Installation +* Download the git repo +* Move files into the scenario folder (C:\Users\User\AppData\Roaming\Factorio\scenarios\ExpGamingScenario) +* Make edits to role and group configs as well as any other configs that you want +* Run the scenario under Play > Multiplayer > Host Scenario > ExpGamingScenario +* All modules will be loaded if you have not removed any, any problems see log file -#### Using The Addons -1. Copy the addons folder -2. Remove any you do not wish to have -3. Remove the require inside the addons load.lua - -#### Making Your Own Addons -* You must have the core files and StdLib -* The load.lua is the only file outside your own you need to edit -* Keep the core files updated with the core branch -* Try not to edit StdLib or the core files -* There is many comments inside the core files to describe how to use them. - -#### Stand Alone File -* This file contains a few scripts from else where which don't require any lib -* StdLib and ExpLib are the only exceptions as these are very basic functions -* Any files added to this folder must be given proper sources -* Each file must be self contained with no _G variables +#### Creation of new modules +* Please see [FactorioSoftmodManager](https://github.com/explosivegaming/FactorioSoftmodManager) for making new modules #### Forks and Pull Requests -* We are happy for people to make pull requets if you wish to help make our server better -* You can add a comment at the start of the file to mark any changes you make, for the credit -* Your server is a comunity server, it is all about the people and feedback is good -* Dont make small changes to the core files, please only big meaniful changes -* Dont be afraid to make a pull request as if it fixes something then its a good change +* We are happy for people to make pull requests if you wish to help make our server better +* Your server is a community server, it is all about the people and feedback is good +* Dont be afraid to make a pull request as if it fixes something then its a good change \ No newline at end of file