Update contributing and readme

Extra details and simplify
master
Craig Davison 2018-06-16 15:22:31 +01:00
parent ca76c595b6
commit 0e551ce394
No known key found for this signature in database
GPG Key ID: B22B44578F8BBB74
2 changed files with 66 additions and 113 deletions

View File

@ -1,26 +1,5 @@
# Contributing
> **Contributions are welcome!** Here's how you can help. :raised_hands:
If you're requesting a big change or wanting a new mod installed its best off asking me first before starting to code it.
<p align="center">
<b><a href="#code">Code</a></b>
·
<b><a href="#something-else">Something else</a></b>
</p>
## Code
1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository and [clone](https://help.github.com/articles/cloning-a-repository/) your fork.
2. Start editing!
3. Commit & [push](https://help.github.com/articles/pushing-to-a-remote/) your changes to a new branch.
4. Once you're happy with your changes, [create a pull request](https://help.github.com/articles/creating-a-pull-request/).
If creating a pull request for a big change that takes a lot of work please let me know first to avoid potential dissapointment.
When adding or removing a mod please update the mod list in `README.md`
## Something else
Questions, feedback & ideas are all welcome - just [open an issue](https://github.com/davisonio/craig-server_game/issues)! :smile:
Alternatively you can [contact the authors](https://github.com/davisonio/craig-server_game#authors).
When updating mod details, update its entry in `readme.md`.

154
readme.md
View File

@ -1,106 +1,80 @@
# [Craig's Server Game](https://davison.io/minetest/craig-server_game/) :video_game: [![](https://img.shields.io/travis/davisonio/craig-server_game.svg?style=flat-square)](https://travis-ci.org/davisonio/craig-server_game) [![](https://img.shields.io/gitter/room/davisonio/craig-server_game.svg)](https://gitter.im/davisonio/craig-server_game)
# Craig's Server Game
> Game used by Craig's [Minetest](http://www.minetest.net) Server
> Game used by Craig's [Minetest](https://www.minetest.net) Server
<p align="center">
<b><a href="#install">Install</a></b>
·
<b><a href="#mod-list">Mod List</a></b>
·
<b><a href="#authors">Authors</a></b>
·
<b><a href="#license--credits">License & Credits</a></b>
</p>
This is the game that runs my Minetest Server. You can connect to the world at `minetest.davison.io` port `3000`.
This is the game used by Craig's Minetest Server.
![](https://davison.io/assets/img/minetest-craig-server_game-screenshot.jpg)
## Install
###### Requirements
- [Minetest](http://www.minetest.net) >= `0.4.16`
[Download](https://github.com/davisonio/craig-server_game/archive/master.zip) & unzip the game, rename it to "craig-server_game" and move it into your `minetest/games` folder.
Since 2013, I've been adding, tweaking and removing mods to create a great game codebase that can keep a server alive and thriving for many years. This, I consider, to be a great setup if you are looking to create a great Minetest Server experience.
![Screenshot](https://davison.io/assets/img/minetest-craig-server_game-screenshot.jpg)
## Mod List
| Name | Forum | Source |
|-------------------------------------------|-------|--------|
|3D Armor (3d_armor)|[4654](https://forum.minetest.net/viewtopic.php?id=4654)|[GitHub/stujones11](https://github.com/stujones11/minetest-3d_armor/tree/master/3d_armor)|
|3D Armor sfinv (3d_armor_sfinv)|[4654](https://forum.minetest.net/viewtopic.php?id=4654)|[GitHub/stujones11](https://github.com/stujones11/minetest-3d_armor/tree/master/3d_armor)|
|Miscellaneous (_misc)|||
|Advanced Area Protection (areas)|[7239](https://forum.minetest.net/viewtopic.php?id=7239)|[GitHub/ShadowNinja](https://github.com/ShadowNinja/areas)|
|Arrow Signs (arrow_signs)|[3353](https://forum.minetest.net/viewtopic.php?id=3353)|[Bitbucket/adrido](https://bitbucket.org/adrido/arrow_signs)|
|BitChange (bitchange)|[7821](https://forum.minetest.net/viewtopic.php?id=7821)|[GitHub/SmallJoker](https://github.com/SmallJoker/bitchange)|
|Bucket (bucket)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/bucket)|
|Carts (carts)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/carts)|
|Coloured Stone Bricks (colouredstonebricks)|[8784](https://forum.minetest.net/viewtopic.php?id=8784)|[GitHub/davisonio](https://github.com/davisonio/colouredstonebricks)|
|Craft Guide (craftguide)|[14088](https://forum.minetest.net/viewtopic.php?t=14088)|[GitHub/minetest-mods](https://github.com/minetest-mods/craftguide)|
|Creative (creative)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/creative)|
|Darkage (darkage)|[10063](https://forum.minetest.net/viewtopic.php?id=10063)|[GitHub/davisonio](https://github.com/davisonio/darkage)|
|Default (default)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/default)|
|Doors (doors)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/doors)|
|Dye (dye)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/dye)|
|Email (email)|[13754](https://forum.minetest.net/viewtopic.php?id=13754)|[GitHub/rubenwardy](https://github.com/rubenwardy/email)|
|Fake Fire (fake_fire)|[2041](https://forum.minetest.net/viewtopic.php?id=2041)|[GitHub/minetest-mods](https://github.com/minetest-mods/homedecor_modpack/tree/master/fake_fire)|
|Farming (farming)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/farming)|
|Flowers (flowers)||[GitHub/flowers](https://github.com/minetest/minetest_game/tree/master/mods/flowers)|
|Give initial stuff (give_initial_stuff)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/give_initial_stuff)|
|Gloopblocks (gloopblocks)|[4019](https://forum.minetest.net/viewtopic.php?id=4019)|[GitHub/minetest-mods](https://github.com/minetest-mods/gloopblocks)|
|Homedecor (homedecor)|[2041](https://forum.minetest.net/viewtopic.php?id=2041)|[GitHub/minetest-mods](https://github.com/minetest-mods/homedecor_modpack/tree/master/homedecor)|
|Homedecor i18n (homedecor_i18n)|[2041](https://forum.minetest.net/viewtopic.php?id=2041)|[GitHub/minetest-mods](https://github.com/minetest-mods/homedecor_modpack/tree/master/homedecor_i18n)|
|Interact (interact)|[11200](https://forum.minetest.net/viewtopic.php?id=11200)|[GitHub/minetest-mods](https://github.com/minetest-mods/interact)|
|IRC (irc)|[3905](https://forum.minetest.net/viewtopic.php?id=3905)|[GitHub/minetest-mods](https://github.com/minetest-mods/irc)|
|IRC commands (irc_commands)|[5275](https://forum.minetest.net/viewtopic.php?id=5275)|[GitHub/ShadowNinja](https://github.com/ShadowNinja/minetest-irc_commands)|
|Item Frames (itemframes)|[2041](https://forum.minetest.net/viewtopic.php?id=2041)|[GitHub/minetest-mods](https://github.com/minetest-mods/homedecor_modpack/tree/master/itemframes)|
|Locked Sign (locked_sign)|[2256](https://forum.minetest.net/viewtopic.php?id=2256)||
|Living Room Furniture (lrfun)|[2041](https://forum.minetest.net/viewtopic.php?id=2041)|[GitHub/minetest-mods](https://github.com/minetest-mods/homedecor_modpack/tree/master/lrfurn)|
|Area Protection Markers (markers)|[124128](https://forum.minetest.net/viewtopic.php?pid=124128)|[GitHub/Sokomine](https://github.com/Sokomine/markers)|
|More Chests (more_chests)||[GitHub/minetest-mods](https://github.com/minetest-mods/more_chests)|
|More Blocks (moreblocks)|[509](https://forum.minetest.net/viewtopic.php?id=509)|[GitHub/minetest-mods](https://github.com/minetest-mods/moreblocks)|
|More Ores (moreores|[549](https://forum.minetest.net/viewtopic.php?id=549)|[GitHub/minetest-mods](https://github.com/minetest-mods/moreores)|
|Name Restrictions (name_restrictions)||[GitHub/ShadowNinja](https://github.com/ShadowNinja/name_restrictions)|
|Names per IP (names_per_ip)|[9768](https://forum.minetest.net/viewtopic.php?id=9768)|[GitHub/Calinou](https://github.com/Calinou/carbone/tree/master/mods/names_per_ip)|
|Nyan Cat (nyancat)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/91182d6a9ec56c88096c1bad653a85426892c54d/mods/nyancat)|
|Replacer (replacer)|[4676](https://forum.minetest.net/viewtopic.php?id=4676)|[GitHub/Sokomine](https://github.com/Sokomine/replacer)|
|Report (report)|[13752](https://forum.minetest.net/viewtopic.php?id=13752)|[GitHub/rubenwardy](https://github.com/rubenwardy/report)|
|Screwdriver (screwdriver)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/screwdriver)|
|Simple Fast Inventory (sfinv)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/sfinv)|
|Simple Fast Inventory Buttons (sfinv_buttons)||[repo.or.cz](http://repo.or.cz/minetest_sfinv_buttons.git)|
|Shields (shields)|[4654](https://forum.minetest.net/viewtopic.php?id=4654)|[GitHub/stujones11](https://github.com/stujones11/minetest-3d_armor/tree/master/shields)|
|Simple Skins (simple_skins)|[9100](https://forum.minetest.net/viewtopic.php?id=9100)|[GitHub/tenplus1](https://github.com/tenplus1/simple_skins)|
|Stairs (stairs)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/stairs)|
|Streets (streets)|[2984](https://forum.minetest.net/viewtopic.php?id=2984)|[GitHub/webdesigner97](https://github.com/minetest-streets/streets)|
|TravelNet (travelnet)|[4877](https://forum.minetest.net/viewtopic.php?id=4877)|[GitHub/travelnet](https://github.com/Sokomine/travelnet)|
|Unified Dyes (unifieddyes)|[2178](https://forum.minetest.net/viewtopic.php?id=2178)|[GitHub/minetest-mods](https://github.com/minetest-mods/unifieddyes)|
|Vessels (vessels)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/vessels)|
|Wieldview (wieldview)|[4654](https://forum.minetest.net/viewtopic.php?id=4654)|[GitHub/stujones11](https://github.com/stujones11/minetest-3d_armor/tree/master/wieldview)|
|Wool (wool)||[GitHub/minetest](https://github.com/minetest/minetest_game/tree/master/mods/wool)|
|WorldEdit (worldedit)|[572](https://forum.minetest.net/viewtopic.php?id=572)|[GitHub/Uberi](https://github.com/Uberi/Minetest-WorldEdit/tree/master/worldedit)|
|WorldEdit commands (worldedit_commands)|[572](https://forum.minetest.net/viewtopic.php?id=572)|[GitHub/Uberi](https://github.com/Uberi/Minetest-WorldEdit/tree/master/worldedit_commands)|
|WorldEdit GUI (worldedit_gui)|[572](https://forum.minetest.net/viewtopic.php?id=572)|[GitHub/Uberi](https://github.com/Uberi/Minetest-WorldEdit/tree/master/worldedit_gui)|
|Extended Ban v2 (xban2)|[9315](https://forum.minetest.net/viewtopic.php?id=9315)|[GitHub/minetest-mods](https://github.com/minetest-mods/xban2)|
* 3d_armor
* 3d_armor_sfinv
* `_misc`
* areas
* arrow_signs
* bitchange
* bucket
* carts
* colouredstonebricks
* craftguide
* creative
* darkage
* default
* doors
* dye
* email
* fake_fire
* farming
* flowers
* give_initial_stuff
* gloopblocks
* home_gui
* homedecor
* homedecor_i18n
* interact
* irc
* irc_commands
* itemframes
* locked_sign
* lrfurn
* markers
* more_chests
* moreblocks
* moreores
* nyancat
* replacer
* report
* screwdriver
* sfinv
* sfinv_buttons
* shields
* simple_skins
* stairs
* streets
* travelnet
* unifieddyes
* vessels
* wieldview
* wool
* worldedit
* worldedit_commands
* worldedit_gui
* xban2
## Authors
## Credits
**[Craig Davison](https://davison.io)**
[![](https://img.shields.io/github/followers/davisonio.svg?style=social&label=Follow%20davisonio)](https://github.com/davisonio) [![](https://img.shields.io/twitter/follow/davisonio.svg?style=social)](https://twitter.com/davisonio)
[![GitHub](https://img.shields.io/github/followers/davisonio.svg?style=social&label=Follow%20@davisonio)](https://github.com/davisonio) [![Twitter](https://img.shields.io/twitter/follow/davisonio.svg?style=social)](https://twitter.com/davisonio)
With many thanks to the [contributors](https://github.com/davisonio/craig-server_game/graphs/contributors). :clap:
...and [contributors](https://github.com/davisonio/craig-server_game/graphs/contributors).
**Contributions are welcome!** Check out the [Contributing Guidelines](https://github.com/davisonio/craig-server_game/blob/master/CONTRIBUTING.md). :raised_hands:
**[Contributions are welcome!](https://github.com/davisonio/craig-server_game/blob/master/contributing.md)**
## License & Credits
## License
Unless otherwise stated:
- Copyright © 2014+ [Craig Davison](https://davison.io). Released under the [WTFPL](http://www.wtfpl.net/txt/copying/).
Based on [Minetest Game](https://github.com/minetest/minetest_game):
- [License](https://github.com/minetest/minetest_game/blob/master/README.txt).
- Copyright © 2013+ [Craig Davison](https://davison.io). Licensed under [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/).