RedMew/README.md

[![Build Status](https://travis-ci.com/Refactorio/RedMew.svg?branch=develop)](https://travis-ci.com/Refactorio/RedMew)
[![Discord](https://img.shields.io/discord/432567222481846283.svg)](https://redmew.com/discord)
[![Downloads](https://img.shields.io/github/downloads/Refactorio/RedMew/total.svg)](https://github.com/Refactorio/RedMew/releases)
[![License](https://img.shields.io/github/license/Refactorio/Redmew.svg)](LICENSE)
[![Activity Level](https://img.shields.io/github/commit-activity/m/Refactorio/RedMew.svg)](https://github.com/Refactorio/RedMew/pulse/monthly)
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/redmew/localized.svg)](https://crowdin.com/project/redmew)

[![RedMew](redmew_git_banner.png)](http://redmew.com)

### Quick note:

Downloads of the repository and the source code in releases require the file `map_selection.sample.lua` to be renamed to `map_selection.lua`. Release assets named for maps have this file built in.

# RedMew

RedMew is a Factorio community that hosts custom servers, maps in different shapes and sizes, scripted scenarios and
modded servers. All of the games hosted are available to the public and our community is meant for players of all skill
levels and experience. You can find out servers by searching for "RedMew" in the multiplayer lobby.

## The Community
You can join the RedMew community on Discord by visiting http://redmew.com/discord

To join a RedMew Factorio server, follow the following steps in Factorio:
 - From the main menu, press "Play"
 - In the next window press "Multiplayer"
 - Next select "Browse public games" (this requires a factorio account and may prompt you to log in)
 - In the list of "Browse games" you can filter for "RedMew" and you will see all RedMew hosted maps

> _Note_: Not every server in this list will be official. If you're in doubt, join our Discord and ask.

## Documentation
Looking for a way to play a RedMew scenario yourself? [Check out our wiki!](https://github.com/Refactorio/RedMew/wiki).

Are you a Content Creator looking to play a RedMew scenario? [Visit the Content Creator Guide!](https://docs.google.com/document/d/1KE20uAOIVeQG2-Kh7OjcmU39e71m1PLk79EGr1ZWn7c/edit?usp=sharing)

## Contributing
If you wish to contribute, don't hesitate to make a Pull Request or open an issue. When in doubt, you can always ask
on [Discord](http://redmew.com/discord).

## License
The RedMew codebase is licensed under the [GPL3 License](LICENSE).
Issue release on push to develop 2020-08-30 22:47:14 +02:00			`[![Build Status](https://travis-ci.com/Refactorio/RedMew.svg?branch=develop)](https://travis-ci.com/Refactorio/RedMew)`
Add badges to readme 2019-02-21 11:52:01 +02:00			`[![Discord](https://img.shields.io/discord/432567222481846283.svg)](https://redmew.com/discord)`
			`[![Downloads](https://img.shields.io/github/downloads/Refactorio/RedMew/total.svg)](https://github.com/Refactorio/RedMew/releases)`
			`[![License](https://img.shields.io/github/license/Refactorio/Redmew.svg)](LICENSE)`
			`[![Activity Level](https://img.shields.io/github/commit-activity/m/Refactorio/RedMew.svg)](https://github.com/Refactorio/RedMew/pulse/monthly)`
Crowdin sync 2019-05-29 (#928) * Crowdin sync 2019-05-29 * fix cs technology tag * Fixed rich text, new crowdin sync Crowdin sync at 20:15 UTC 2019-05-29 * First diggy localisedStrings * Added missing localisedString * Updated readme + CI fix 2019-05-29 23:13:28 +02:00			`[![Crowdin](https://d322cqt584bo4o.cloudfront.net/redmew/localized.svg)](https://crowdin.com/project/redmew)`
Add badges to readme 2019-02-21 11:52:01 +02:00
Added a banner to the readme 2018-10-27 10:14:53 +02:00			`[![RedMew](redmew_git_banner.png)](http://redmew.com)`

Add note to readme 2019-02-21 22:00:27 +02:00			`### Quick note:`

Correct map_selection.sample.lua in readme.md (#1318) 2022-05-01 17:24:18 +02:00			Downloads of the repository and the source code in releases require the file `map_selection.sample.lua` to be renamed to `map_selection.lua`. Release assets named for maps have this file built in.
Add note to readme 2019-02-21 22:00:27 +02:00
			`# RedMew`

Reworked the documentation structure 2018-10-25 19:50:00 +02:00			`RedMew is a Factorio community that hosts custom servers, maps in different shapes and sizes, scripted scenarios and`
Tweak readme (mostly to test the github webhook script) 2019-02-19 05:57:59 +02:00			`modded servers. All of the games hosted are available to the public and our community is meant for players of all skill`
			`levels and experience. You can find out servers by searching for "RedMew" in the multiplayer lobby.`
Create README.md 2018-03-24 20:46:20 +02:00
Reworked the documentation structure 2018-10-25 19:50:00 +02:00			`## The Community`
			`You can join the RedMew community on Discord by visiting http://redmew.com/discord`
Create README.md 2018-03-24 20:46:20 +02:00
Reworked the documentation structure 2018-10-25 19:50:00 +02:00			`To join a RedMew Factorio server, follow the following steps in Factorio:`
			`- From the main menu, press "Play"`
			`- In the next window press "Multiplayer"`
			`- Next select "Browse public games" (this requires a factorio account and may prompt you to log in)`
			`- In the list of "Browse games" you can filter for "RedMew" and you will see all RedMew hosted maps`
Create README.md 2018-03-24 20:46:20 +02:00
Wording change to test webhook 2019-01-26 15:45:05 +02:00			`> _Note_: Not every server in this list will be official. If you're in doubt, join our Discord and ask.`
Create README.md 2018-03-24 20:46:20 +02:00
Reworked the documentation structure 2018-10-25 19:50:00 +02:00			`## Documentation`
Docs into wiki (#510) * Docs into wiki * Redirect readme 2018-12-06 13:27:29 +02:00			`Looking for a way to play a RedMew scenario yourself? [Check out our wiki!](https://github.com/Refactorio/RedMew/wiki).`
Create README.md 2018-03-24 20:46:20 +02:00
Fix punctuation 2019-02-23 20:34:58 +02:00			`Are you a Content Creator looking to play a RedMew scenario? [Visit the Content Creator Guide!](https://docs.google.com/document/d/1KE20uAOIVeQG2-Kh7OjcmU39e71m1PLk79EGr1ZWn7c/edit?usp=sharing)`
Update README.md with a link Linked to Content Creator guide under Documentation. 2019-02-23 10:12:13 +02:00
Added small reference on contributing 2018-10-25 20:09:48 +02:00			`## Contributing`
			`If you wish to contribute, don't hesitate to make a Pull Request or open an issue. When in doubt, you can always ask`
			`on [Discord](http://redmew.com/discord).`

Reworked the documentation structure 2018-10-25 19:50:00 +02:00			`## License`
			`The RedMew codebase is licensed under the [GPL3 License](LICENSE).`