Skip to content

Commit

Permalink
Update readme and add license
Browse files Browse the repository at this point in the history
  • Loading branch information
mpigsley committed Aug 11, 2017
1 parent a29a92c commit 0154da8
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 30 deletions.
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [year] [fullname]

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.
44 changes: 14 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,23 @@
# Sectors Without Number

A seeded, random, revised edition compliant, [stars without number](http://www.sinenomine-pub.com/?page_id=395) sector generator.

[![Build Status](https://travis-ci.org/mpigsley/sectors-without-number.svg?branch=master)](https://travis-ci.org/mpigsley/sectors-without-number)

**Warning: In Progress**

A seeded, random stars without number sector generator based completely in the web.

## Alpha Roadmap
* [x] Generate a hexagonal playing grid
* [x] Create way to configure seed/grid size
* [x] Generate a sector based on seed and a grid size
* [x] Generate a random sector name
* [x] Generate random star names
* [x] Generate a random number of planets (weighted)
* [x] Generate planet tags
* [x] Draw sector on hexagonal playing grid
* [x] Center grid within view
* [x] Scale view based on size of screen
* [x] Draw dots in hexes that contain stars
* [x] Add hexagonal hover state
* [x] Draw grid coordinates (scale based on size and remove when too small)
* [ ] Render system information
* [x] Create information sidebar (scale hex grid area based on open/close)
* [x] Render star information
* [ ] Render planet information
* [x] Render sector hover tooltip with basic system information
* [x] Generate share link
## Feature Requests & Bugs

Feel free to [open an issue](https://github.com/mpigsley/sectors-without-number/issues/new) if you there is a feature you'd like to or something is broken. Pull requests are always welcome.

## Development

This project is purely a front-end application written in React + Redux.

To get started just install modules with `npm install` and run the application with `npm start`.

For more information see [create-react-app](https://github.com/facebookincubator/create-react-app).

## Possible Features

* Create login/signup workflow to save multiple sectors
* Create process to wire up sector manually (if the user wants to roll their own)
* Full customization (stars, planets, tags, etc.)
Expand All @@ -39,15 +29,9 @@ A seeded, random stars without number sector generator based completely in the w
* Languages (create planet/city names based on language)
* Exact Star/Planet Size
* Planet Distance from Star (will dictate temperature/habitability of planet)
* Planet Temperature
* Planet/Star Rotation Period
* Sector travel tool
* Use WebGL to render a random 3D image of planet or moon
* Add locations of major cities
* Add secret location
* Add way for user to add new locations to 3d view


## Development

To run the project see [create-react-app](https://github.com/facebookincubator/create-react-app).

0 comments on commit 0154da8

Please sign in to comment.