Merge branch 'release/5.6.0'

Author: Cooldude2606

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -1,28 +1,30 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Report a bug which does not crash the game, any bug from the latest major scenario version
 
 ---
 
-**Describe the bug**
+**Factorio version**
+Version number: X.Y.Z
+
+**Scenario version**
+Version number: X.Y.Z
+
+**Bug description**
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+**Reproduction method**
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
-4. See error
+4. See error in log
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Other information (please complete the following information):**
- - OS: [e.g. iOS, Windows, Linux]
- - Factorio Version: [e.g. 0.16.30]
-
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/Desync_report.md

@@ -0,0 +1,24 @@
+---
+name: Desync report
+about: Report a desync, latest version of scenario only including patches
+
+---
+
+**Factorio version**
+Version number: X.Y.Z
+
+**Scenario version**
+Version number: X.Y.Z
+
+**Desync description**
+A clear and concise description of what you believe causes the desync.
+
+**Reproduction method**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error in log
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/Error_report.md

@@ -1,33 +1,35 @@
 ---
-name: Error/Desync Report
-about: Create a report on a bug which gives an error or desync
+name: Error report
+about: Report a bug which cases the game to crash, any bug from the latest major scenario version
 
 ---
 
-**Error Message**
-Error: insert error message
+**Factorio version**
+Version number: X.Y.Z
 
-**Known Causes**
-Know causes that will result in error:
- - Cause 1
- - Cause 2
+**Scenario version**
+Version number: X.Y.Z
 
-**To Reproduce (please give for each cause outlined above)**
+**Error message**
+```
+error message and stacktrace back
+```
+
+**Error description**
+A clear and concise description of what you believe causes the crash.
+
+**Reproduction method**
 Steps to reproduce the behavior:
- - Cause 1
-    1. Go to '...'
-    2. Click on '....'
-    3. Scroll down to '....'
-    4. See error
- - Cause 2
-    1. Go to '...'
-    2. Click on '....'
-    3. Scroll down to '....'
-    4. See error
-
-**Other information (please complete the following information):**
- - OS: [e.g. iOS, Windows, Linux]
- - Factorio Version: [e.g. 0.16.30]
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error in log
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/Feature_request.md

@@ -1,17 +1,18 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
+about: Suggest a new idea to be worked on
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Feature overview**
+Name: name-here
+TL;DR: a few words about what the feature is
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Details**
+A detailed description of what the new feature is.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Possible methods**
+Any ideas you have had about how to implement the feature or any problems that may arise.
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots about the feature request here.

README.md

@@ -16,28 +16,91 @@
   <a href="https://www.codefactor.io/repository/github/explosivegaming/scenario">
     <img src="https://www.codefactor.io/repository/github/explosivegaming/scenario/badge" alt="CodeFactor">
   </a>
-  <a href="https://discord.me/explosivegaming">
+  <a href="https://discord.explosivegaming.nl">
     <img src="https://discordapp.com/api/guilds/260843215836545025/widget.png?style=shield" alt="Discord">
   </a>
 </p>
-<h2 align="center">ExpGaming Scenario Repository</h2>
+<h1 align="center">ExpGaming Scenario Repository</h2>
 
-<p align="center"><font size="-2">Out Dated; Will be updated in the future</font></p>
+## Explosive Gaming
 
-#### Use and Installation
+Explosive Gaming (often ExpGaming) is a server hosting community with a strong focus on Factorio and games that follow similar ideas. Our factorio server are known for hosting large maps with the main goal of being a "mega base" which can produce as much as possible with in our reset schedule. Although these server tend to the more experienced players our server are open to everyone. You can find us through our [website](website), [discord](discord), [wiki](wiki), or in the public games tab in factorio (ExpGaming S1).
 
-* 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
+## Use and Installation
 
-#### Creation of new modules
+1) Download this [git repository](https://github.com/explosivegaming/scenario/archive/master.zip) for the stable release. The dev branch can be found [here](https://github.com/explosivegaming/scenario/archive/dev.zip) for those who want the latest features. See [releases](#releases) for other release branches.
 
-* Please see [FactorioSoftmodManager](https://github.com/explosivegaming/FactorioSoftmodManager) for making new modules
+2) Extract the downloaded zip file from the branch you downloaded into factorio's scenario directory:
+    * Windows: `%appdata%\Factorio\scenarios`
+    * Linux: `~/.factorio/scenarios`
 
-#### Forks and Pull Requests
+3) Within the scenario you can find `./config/_file_loader.lua` which contains a list of all the modules that will be loaded by the scenario; simply comment out (or remove) features you do not want but note that some modules may load other modules as dependencies even when removed from the list.
 
-* 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
+4) More advanced users may want to play with the other configs files within `./config` but please be aware that some of the config files will require a basic understanding of lua while others may just be a list of values.
+
+5) Once you have made any config changes that you wish to make open factorio, select play, then start scenario (or host scenario from within multiplayer tab), and select the scenario which will be called `scenario-master` if you have downloaded the latest stable release and have not changed the folder name.
+
+6) The scenario will now load all the selected modules and start the map, any errors or exceptions raised in the scenario should not cause a game/server crash so if any features don't work as expected then it may be returning an error in the log, please report these errors to [the issues page](issues).
+
+## Contributing
+
+All are welcome to make pull requests and issues for this scenario, if you are in any doubt please ask someone in our [discord](discord). If you do not know lua and don't feel like learning you can always make a [feature request](issues). Please keep in mind while making code changes:
+
+* New features should have the branch names: `feature/feature-name`
+* New features are merged into `dev` after it has been completed.
+* After a number of features have been added a release branch is made: `release/X.Y.0`; this branch should have no new features and only bug fixes or localization.
+* A release is merged into `master` on the following friday in time for the the weekly reset.
+* Patches may be named `patch/X.Y.Z` and fill be merged into `master` and `dev` when appropriate.
+
+## Releases
+
+| Scenario Version* | Version Name | Factorio Version** |
+|---|---|---|
+| [v5.6](s5.6) | Information Guis | [v0.17.44](f0.17.44) |
+| [v5.5](s5.5) | Gui System | [v0.17.43](f0.17.43) |
+| [v5.4](s5.4) | Admin Controls | [v0.17.32](f0.17.32) |
+| [v5.3](s5.3) | Custom Roles | [v0.17.28](f0.17.28) |
+| [v5.2](s5.2) | Quality of life | [v0.17.22](f0.17.22) |
+| [v5.1](s5.1) | Permission Groups | [v0.17.13](f0.17.13) |
+| [v5.0](s5.0) | 0.17 Overhaul| [v0.17](f0.17.9) |
+| [v4.0](s4.0) | Softmod Manager | [v0.16.51](f0.16.51) |
+| [v3.0](s3.0) | 0.16 Overhaul | [v0.16](f0.16) |
+| [v2.0](s2.0) | Localization and clean up | [v0.15](f0.15) |
+| [v1.0](s1.0) | Modulation | [v0.15](f0.15) |
+| [v0.1](s0.1) | First Tracked Version | [v0.14](f0.14) |
+\* Scenario patch versions have been omitted.
+
+\** Factorio versions show the version they were made for, often the minimum requirement.
+
+[s5.6]: https://github.com/explosivegaming/scenario/releases/tag/5.6.0
+[s5.5]: https://github.com/explosivegaming/scenario/releases/tag/5.5.0
+[s5.4]: https://github.com/explosivegaming/scenario/releases/tag/5.4.0
+[s5.3]: https://github.com/explosivegaming/scenario/releases/tag/5.3.0
+[s5.2]: https://github.com/explosivegaming/scenario/releases/tag/5.2.0
+[s5.1]: https://github.com/explosivegaming/scenario/releases/tag/5.1.0
+[s5.0]: https://github.com/explosivegaming/scenario/releases/tag/5.0.0
+[s4.0]: https://github.com/explosivegaming/scenario/releases/tag/v4.0
+[s3.0]: https://github.com/explosivegaming/scenario/releases/tag/v3.0
+[s2.0]: https://github.com/explosivegaming/scenario/releases/tag/v2.0
+[s1.0]: https://github.com/explosivegaming/scenario/releases/tag/v1.0
+[s0.1]: https://github.com/explosivegaming/scenario/releases/tag/v0.1
+
+[f0.17.44]: https://wiki.factorio.com/Version_history/0.17.0#0.17.44
+[f0.17.32]: https://wiki.factorio.com/Version_history/0.17.0#0.17.32
+[f0.17.28]: https://wiki.factorio.com/Version_history/0.17.0#0.17.28
+[f0.17.22]: https://wiki.factorio.com/Version_history/0.17.0#0.17.22
+[f0.17.13]: https://wiki.factorio.com/Version_history/0.17.0#0.17.13
+[f0.17.9]: https://wiki.factorio.com/Version_history/0.17.0#0.17.9
+[f0.16.51]: https://wiki.factorio.com/Version_history/0.16.0#0.16.51
+[f0.16]: https://wiki.factorio.com/Version_history/0.16.0
+[f0.15]: https://wiki.factorio.com/Version_history/0.15.0
+[f0.14]: https://wiki.factorio.com/Version_history/0.14.0
+
+## License
+
+The Explosive Gaming codebase is licensed under the [GNU General Public License v3.0](https://github.com/explosivegaming/scenario/blob/master/LICENSE)
+
+[issues]: https://github.com/explosivegaming/scenario/issues/new/choose
+[website]: https://explosivegaming.nl
+[discord]: https://discord.explosivegaming.nl
+[wiki]: https://wiki.explosivegaming.nl

config/file_loader.lua config/_file_loader.luaconfig/file_loader.lua renamed to config/_file_loader.lua

@@ -22,23 +22,28 @@ return {
     'modules.commands.reports',
     'modules.commands.spawn',
     'modules.commands.warnings',
+    'modules.commands.find',
     -- QoL Addons
     'modules.addons.chat-popups',
     'modules.addons.damage-popups',
     'modules.addons.death-logger',
-    'modules.addons.advanced-starting-items',
+    'modules.addons.advanced-start',
     'modules.addons.spawn-area',
     'modules.addons.compilatron',
     'modules.addons.scorched-earth',
     'modules.addons.pollution-grading',
     'modules.addons.random-player-colours',
     -- GUI
+    'modules.gui.rocket-info',
+    'modules.gui.science-info',
+    'modules.gui.task-list',
+    'modules.gui.player-list',
     'modules.commands.debug',
     -- Config Files
-    'config.command_auth_admin', -- commands tagged with admin_only are blocked for non admins
-    'config.command_auth_roles', -- commands must be allowed via the role config
-    'config.command_auth_runtime_disable', -- allows commands to be enabled and disabled during runtime
+    'config.expcore-commands.auth_admin', -- commands tagged with admin_only are blocked for non admins
+    'config.expcore-commands.auth_roles', -- commands must be allowed via the role config
+    'config.expcore-commands.auth_runtime_disable', -- allows commands to be enabled and disabled during runtime
     'config.permission_groups', -- loads some predefined permission groups
     'config.roles', -- loads some predefined roles
-    'expcore.gui.test'
+    'expcore.gui.test' -- loads multiple gui defines to test the gui system
 }