[SteemNova] - Project repository documentation and licensing

View this thread on: d.buzz | hive.blog | peakd.com | ecency.com
·@mys·
0.000 HBD
[SteemNova] - Project repository documentation and licensing
<center>![](https://steemitimages.com/DQmNhKvcRhp5THpijqS45M18MiDpg1Cvc78Sv9rKCiJi5NJ/image.png)</center>

Documentation and usage licensing rules were written for [SteemNova](https://github.com/steemnova/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](https://github.com/jkroepke/2Moons) engine. Project is destined to be Steemian-only game with opportunity to modify game code by community, most probably [Utopians](https://utopian.io/) as a contribution.

<table width="100%" border="0">
  <tr>    
  <td><img src="https://www.steem.center/images/archive/5/55/20160814202358%21Steem_Logo.png" align="left" /></td>
  <td><img src="https://res.cloudinary.com/hpiynhbhq/image/upload/v1517062408/kl5volw13mznbzstfaep.png" align="center" /></td>
  <td><img src="https://ievgensaxblog.files.wordpress.com/2017/11/github-logo.png" align="right"/></td>
  </tr>
</table>

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

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

<br/>

Plan of SteemNova expansion is specified in Roadmap.

> ##### Roadmap
> <ol>
<li><del>Reorganize github code. Specify README and LICENSE documentation</del>. Fix any game issues if there will be any.</li>
<li>Create SteemNova Board community on top of Steem blockchain.</li>
<li>Game manual and tips &amp; tricks for newbies.</li>
<li>Specify detailed explanation how the reward system will work.</li>
<li>Announce bug bounties, artwork contests and utopian-io task requests for contributors (mobile UI, visual bugs etc.).</li>
<li>Steem accounts integration.</li>
</ol>

<br/>

Instructions how to host game locally in quick steps.

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

## 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](https://github.com/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

<br /><hr/><em>Posted on <a href="https://utopian.io/utopian-io/@mys/steemnova-project-repository-documentation-and-licensing">Utopian.io -  Rewarding Open Source Contributors</a></em><hr/>
👍 , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,