add documentation

This commit is contained in:
unknown 2021-11-23 23:41:36 -05:00
parent cdbf990b8c
commit 9e3dc767c0
8 changed files with 124 additions and 4 deletions

27
LICENSES/CC BY-SA 3.0 Normal file
View File

@ -0,0 +1,27 @@
You are free to:
Share — copy and redistribute the material in any medium or format.
Adapt — remix, transform, and build upon the material for any purpose, even commercially.
The licensor cannot revoke these freedoms as long as you follow the license terms.
Under the following terms:
Attribution — You must give appropriate credit, provide a link to the license, and
indicate if changes were made. You may do so in any reasonable manner, but not in any way
that suggests the licensor endorses you or your use.
ShareAlike — If you remix, transform, or build upon the material, you must distribute
your contributions under the same license as the original.
No additional restrictions — You may not apply legal terms or technological measures that
legally restrict others from doing anything the license permits.
Notices:
You do not have to comply with the license for elements of the material in the public
domain or where your use is permitted by an applicable exception or limitation.
No warranties are given. The license may not give you all of the permissions necessary
for your intended use. For example, other rights such as publicity, privacy, or moral
rights may limit how you use the material.
For more details:
http://creativecommons.org/licenses/by-sa/3.0/

27
LICENSES/CC BY-SA 4.0 Normal file
View File

@ -0,0 +1,27 @@
You are free to:
Share — copy and redistribute the material in any medium or format
Adapt — remix, transform, and build upon the material for any purpose, even commercially.
This license is acceptable for Free Cultural Works.
Under the following terms:
Attribution — You must give appropriate credit, provide a link to the license, and
indicate if changes were made. You may do so in any reasonable manner, but not in any way
that suggests the licensor endorses you or your use.
ShareAlike — If you remix, transform, or build upon the material, you must distribute
your contributions under the same license as the original.
No additional restrictions — You may not apply legal terms or technological measures that
legally restrict others from doing anything the license permits.
Notices:
You do not have to comply with the license for elements of the material in the public
domain or where your use is permitted by an applicable exception or limitation.
No warranties are given. The license may not give you all of the permissions necessary
for your intended use. For example, other rights such as publicity, privacy, or moral
rights may limit how you use the material.
For more details:
http://creativecommons.org/licenses/by-sa/4.0/

20
LICENSES/CC0 Normal file
View File

@ -0,0 +1,20 @@
No Copyright
The person who associated a work with this deed has dedicated the work to the public domain
by waiving all of his or her rights to the work worldwide under copyright law, including
all related and neighboring rights, to the extent allowed by law.
You can copy, modify, distribute and perform the work, even for commercial purposes,
all without asking permission. See Other Information below.
Other Information
In no way are the patent or trademark rights of any person affected by CC0, nor are the rights
that other persons may have in the work or in how the work is used, such as publicity or privacy rights.
Unless expressly stated otherwise, the person who associated a work with this deed makes
no warranties about the work, and disclaims liability for all uses of the work, to the
fullest extent permitted by applicable law.
When using or citing the work, you should not imply endorsement by the author or the affirmer.
For more details:
https://creativecommons.org/publicdomain/zero/1.0/

22
LICENSES/MIT Normal file
View File

@ -0,0 +1,22 @@
The MIT License (MIT)
Copyright (c) 2020-2021 wsor4035(aka wsor) and contributors.
see mod readme files for more info
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

View File

@ -4,11 +4,22 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-blue)](https://creativecommons.org/licenses/by-sa/4.0/)
WIP game
## About
simple little WIP Game that is licensed under MIT and CC BY-SA 4.0.
game built on the minetest engine currently in beta. This game current provides minimal
playable experience but in the long term hopes to become more tech and train focused.
see the roadmap.md file for proposed direction.
## Test Server
A test server running this game can be found at
Address: cw.edgy1.net
Port: 30016
## License
Code: MIT
Media: CC BY-SA 4.0.
## Links
@ -18,7 +29,13 @@ simple little WIP Game that is licensed under MIT and CC BY-SA 4.0.
## Setup
download game, install in /games, if using git, make sure to get the submodules as well
* Git
download game, install in /games, if using git, make sure to get the submodules as well
* Github zip download
github zip download does not include submodules so you will need to obtain copys of those mods
and insert them in there proper place
* Contentdb
should be able to download the game from the content tab and play
## minetest.conf settings

7
ROADMAP.md Normal file
View File

@ -0,0 +1,7 @@
# Proposed features
1. tech system
2. train system
* see fl_trains for the start
3. mobs
* see fl_wildlife for the start

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1003 KiB

BIN
screenshot2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 MiB