FactorioScenarioMultiplayer.../README.md

# FactorioScenarioMultiplayerSpawn
A custom scenario for allowing separate spawn locations in multiplayer. Designed for Co-op and PvE.

## Instructions

### STEP 1

Download the zip. 

Place it in your Factorio/scenarios/... folder.

It should look something like this (for my windows steam install location):

C:\Users\user\AppData\Roaming\Factorio\scenarios\FactorioScenarioMultiplayerSpawn\control.lua

### STEP 2

ALSO download the zip for "locale" from https://github.com/Oarcinae/FactorioUtils

Place this inside the locale folder. It should look like this:

C:\Users\user\AppData\Roaming\Factorio\scenarios\FactorioScenarioMultiplayerSpawn\locale\oarc_utils.lua

### STEP 3

Go into config.lua and edit the strings to add your own server messages.

Rename the "FactorioScenarioMultiplayerSpawn" folder to something shorter and more convenient (optional).


### STEP 4

Generate a new map, use that save file to host if you want to.


## Configuration

Look in config.lua for some controls over the different modules.  

Not all configurations have been fully tested so modify at your own risk.

If you want to change the RSO config, look for the rso_config and rso_resource_config files.


## TODO

I need to update this with more details about the implementation and explain some of the configuration options.

For now, just take a look at the source and it should be easy to understand I hope.


## Credit

RSO is not my own creation. It was done by Orzelek. I requested permission to include it in my scenario.  

https://mods.factorio.com/mods/orzelek/rso-mod

Several other portions of the code (tags, frontier style rocket silo) have also been adapted from other scenario code.

Credit to 3Ra for help as well: https://github.com/3RaGaming


## Random Notes

While it is an option to disable RSO, I would not recommend doing that. I can't guarantee any bugs or issues as I focus mostly on testing with RSO enabled.

Feel free to submit bugs/fixes/requests/pulls/forks whatever you want.

I do not plan on supporting PvP, but I will help anyone who wants to make it a configurable option.
First commit 2016-11-10 05:22:32 -05:00			`# FactorioScenarioMultiplayerSpawn`
			`A custom scenario for allowing separate spawn locations in multiplayer. Designed for Co-op and PvE.`

			`## Instructions`

Updating readme with more detailed instructions for how to use the locale sub-module. 2016-12-28 10:43:08 -08:00			`### STEP 1`

			`Download the zip.`

			`Place it in your Factorio/scenarios/... folder.`
First commit 2016-11-10 05:22:32 -05:00
			`It should look something like this (for my windows steam install location):`

			`C:\Users\user\AppData\Roaming\Factorio\scenarios\FactorioScenarioMultiplayerSpawn\control.lua`

Updating readme with more detailed instructions for how to use the locale sub-module. 2016-12-28 10:43:08 -08:00			`### STEP 2`

			`ALSO download the zip for "locale" from https://github.com/Oarcinae/FactorioUtils`

			`Place this inside the locale folder. It should look like this:`

			`C:\Users\user\AppData\Roaming\Factorio\scenarios\FactorioScenarioMultiplayerSpawn\locale\oarc_utils.lua`

			`### STEP 3`

			`Go into config.lua and edit the strings to add your own server messages.`

			`Rename the "FactorioScenarioMultiplayerSpawn" folder to something shorter and more convenient (optional).`


Fixed resource spawning in starting areas (I think). Added player list panel. Fixed unintended gui click teleports. Changed map creation to create a new surface. 2017-04-27 21:48:28 -04:00			`### STEP 4`

			`Generate a new map, use that save file to host if you want to.`

Updating readme with credit to others 2016-11-26 08:45:51 -08:00
			`## Configuration`

			`Look in config.lua for some controls over the different modules.`

			`Not all configurations have been fully tested so modify at your own risk.`

Updating readme with more detailed instructions for how to use the locale sub-module. 2016-12-28 10:43:08 -08:00			`If you want to change the RSO config, look for the rso_config and rso_resource_config files.`

Updating readme with credit to others 2016-11-26 08:45:51 -08:00
Update README.md Add todo note in readme. 2016-11-10 19:19:48 -05:00			`## TODO`

			`I need to update this with more details about the implementation and explain some of the configuration options.`

Updating readme with more detailed instructions for how to use the locale sub-module. 2016-12-28 10:43:08 -08:00			`For now, just take a look at the source and it should be easy to understand I hope.`
Updating readme with credit to others 2016-11-26 08:45:51 -08:00

			`## Credit`

			`RSO is not my own creation. It was done by Orzelek. I requested permission to include it in my scenario.`

			`https://mods.factorio.com/mods/orzelek/rso-mod`

Adding long-reach soft mod, random silo position, player limit for joining spawns, text changes messages. 2016-12-13 18:46:48 -05:00			`Several other portions of the code (tags, frontier style rocket silo) have also been adapted from other scenario code.`

Fixed resource spawning in starting areas (I think). Added player list panel. Fixed unintended gui click teleports. Changed map creation to create a new surface. 2017-04-27 21:48:28 -04:00			`Credit to 3Ra for help as well: https://github.com/3RaGaming`


			`## Random Notes`

			`While it is an option to disable RSO, I would not recommend doing that. I can't guarantee any bugs or issues as I focus mostly on testing with RSO enabled.`

			`Feel free to submit bugs/fixes/requests/pulls/forks whatever you want.`

			`I do not plan on supporting PvP, but I will help anyone who wants to make it a configurable option.`