aperx/factorio-scenario-ExpCluster
1
0
Fork 0
mirror of https://github.com/PHIDIAS0303/ExpCluster.git synced 2025-12-27 11:35:22 +09:00
Code Issues Packages Projects Releases Wiki Activity

Added Readme

Browse Source
This commit is contained in:
Cooldude2606
2019-01-11 23:27:02 +00:00
parent 901c1a5590
commit e4b840b1b7
1 changed files with 11 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -22,34 +22,17 @@
</p> </p>
<h2 align="center">ExpGaming Scenario Repository</h2> <h2 align="center">ExpGaming Scenario Repository</h2>
#### Using The Core Files #### Use and Installation
1. Copy the core folder and the StdLib File * Download the git repo
2. Copy the control.lua and edit the load.lua in each file * Move files into the scenario folder (C:\Users\User\AppData\Roaming\Factorio\scenarios\ExpGamingScenario)
3. The require order is important in the control.lua * Make edits to role and group configs as well as any other configs that you want
4. Use playerRanks.lua to edit the rank system * Run the scenario under Play > Multiplayer > Host Scenario > ExpGamingScenario
5. Add your own files to the addons folder and require them in the load.lua * All modules will be loaded if you have not removed any, any problems see log file
#### Using The Addons #### Creation of new modules
1. Copy the addons folder * Please see [FactorioSoftmodManager](https://github.com/explosivegaming/FactorioSoftmodManager) for making new modules
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
#### Forks and Pull Requests #### Forks and Pull Requests
* We are happy for people to make pull requets if you wish to help make our server better * We are happy for people to make pull requests 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 community server, it is all about the people and feedback is good
* Your server is a comunity 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
* 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