[SteemNova] - Project repository documentation and licensing

[mys]

Documentation and usage licensing rules were written for SteemNova project at Github. SteemNova is new 2Moons engine-based browsergame for Steemians by @steemnova. Its announcement can be read here https://steemit.com/steemnova/@steemnova/steemnova-ogame-based-browsergame-for-steemians

Details

The README file states clearly that steemnova project is a fork of jkroepke/2Moons engine. Project is destined to be Steemian-only game with opportunity to modify game code by community, most probably Utopians as a contribution.

The repository file-tree structure is described in simplified form. This way contributors can get to specified part of code quickly.

Repository structure

• [cache] - temporary cached server .tpl webpages
• [chat] - AJAX ingame client-side chat
• [includes]
  • game engine
  • configuration
  • administration
  • database scheme
  • external libraries
  • webpages functionality
• [install]
  • first installation
  • database creation
• [language] - translations: DE, EN, ES, FR, PL, PT, RU, TR
• [licenses] - open source license schemes
• [scripts] - client-side web browser .js scripts
• [styles]
  • webpages .css templates
  • webpages .tpl templates
  • fonts
  • images
• [tests]

Plan of SteemNova expansion is specified in Roadmap.

Roadmap

1. Reorganize github code. Specify README and LICENSE documentation. Fix any game issues if there will be any.
2. Create SteemNova Board community on top of Steem blockchain.
3. Game manual and tips & tricks for newbies.
4. Specify detailed explanation how the reward system will work.
5. Announce bug bounties, artwork contests and utopian-io task requests for contributors (mobile UI, visual bugs etc.).
6. Steem accounts integration.

Instructions how to host game locally in quick steps.

Local installation

• Clone the repo: git clone https://github.com/steemnova/steemnova
• Install components: apt-get install apache2 php7.0 php7.0-gd php7.0-fpm php7.0-mysql libapache2-mod mysql-server
• Setup mysql: create user USER identified by PASSWORD; create database DB; grant all privileges on DB.* to USER;
• Set write privileges to dirs: cache/, includes/
• Run wizard: 127.0.0.1/install/install.php

Licensing

Project repository is based on MIT License. It is continuous project of 2Moons Open Source Browsergame Framework.

Copyright and license

SteemNova is a fork of Open Source Browsergame Framework jkroepke/2Moons engine.
Code copyright 2009-2016 Jan-Otto Kröpke released under the MIT License.
Code copyright 2018 @steemnova released under the MIT License.

Links

https://github.com/steemnova/steemnova/pull/2 https://github.com/steemnova/steemnova/blob/master/README.md https://github.com/steemnova/steemnova/blob/master/LICENSE

---

Posted on Utopian.io - Rewarding Open Source Contributors

---

Comments

[mkt]

Your contribution cannot be approved because the amount of work does not qualify to be rewarded.

An informative README.md and a license file should be included in a repository right away. Adding this afterwards cannot count as a valid Documentation contribution.

You can contact us on Discord.
[utopian-moderator]

[mys]

I have nothing more to add at this stage. Project just required the missing README and LICENSE information with few simple instructions.
Thank You for a review!

[utopian.tip]

Hey @mkt, I just gave you a tip for your hard work on moderation. Upvote this comment to support the utopian moderators and increase your future rewards!

[cheetah]

Hi! I am a robot. I just upvoted you! I found similar content that readers might be interested in:
https://steemit.com/steemnova/@steemnova/steemnova-ogame-based-browsergame-for-steemians

[offtherecord]

It's great to see there is progress with this project. I can't wait for it to fully realize it's potential! :D