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

Edit to readme.md

Browse Source
This commit is contained in:
Cooldude2606
2018-01-07 14:54:03 +00:00
committed by Unknown
parent ebb8570e84
commit 85a0014f86
1 changed files with 23 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -1,18 +1,31 @@
#### Using The Core Files #### Using The Core Files
1. Copy the core folder and the StdLib File 1. Copy the core folder and the StdLib File
2. Require StdLib event.lua before the core file-header 2. Copy the control.lua and edit the load.lua in each file
3. Use require to run the file-header inside the core file 3. The require order is imporant in the control.lua
4. Make any changes to the rank table you wish to use 4. Use playerRanks.lua to edit the rank system
5. Add you own code to the stand alone folder using the function defined in core 5. Add your own files to the addons folder and require them in the load.lua
#### Using The Addons #### Using The Addons
1. Copy the addons folder 1. Copy the addons folder
2. Remove any you do not wish to have 2. Remove any you do not wish to have
3. Remove the require inside the addons file-header 3. Remove the require inside the addons load.lua
#### Making Your Own Addons #### Making Your Own Addons
* Make sure to require it after the core files * You must have the core files and StdLib
* Add and return the credits vaible with your info inside * The load.lua is the only file outside your own you need to edit
* Make sure the core is upto date with out latest version * Keep the core files upto data with the core branch
* It is recomened that your do not edit the core file * Try not to edit StdLib or the core files
* The core files use comments to help explain the many functions * There is many comments inside the core files to descripe how to use them.
#### Stand Alone File
* This file ocntains a few scripts from else where which dont 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 sourses
* Each file must be self contained with no _G varibles
#### 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