Skip to content

eschatonic/react-lancer-timeline

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Unofficial Lancer Universe Timeline

Overview

This project seeks to provide a an interactive timeline for content in the Lancer universe using the React framework.

Please note this readme is incomplete and this project not quite ready for primetime.

How to Use

...

Data Formats

The data used to build the timeline can be found in src/lancer-timeline-data.json. The JSON data contains listings for:

  • Factions
  • Sources
  • Publishing Attributes
  • Timeline Entries

The top level structure of the JSON data file is as follows:

{
    "factions": [],
    "sources": [],
    "publishingAttributes": [],
    "timeline": []
}

Factions

...

Sources

...

Publishing Attributes

...

Timeline Entries

Timeline entries are represented in the following format:

{
    "year": (number; start year for the entry),
    "era": (string; the era of the timeline designated as "BU" or "U"),
    "faction": (string: the faction key, choose one from the `factions` node in the JSON data library),
    "title": (string: title of the timeline entry),
    "descr": (string: the description of the timeline entry),
    "sources": [
        {
            "source": (string: the source of the timeline entry)
            "sourceLocation": (string: the location of the timeline entry in the source, usually pages in a book)
        }
    ]
}

Example entry:

{
    "year": 5500,
    "era": "BU",
    "faction": "ktb",
    "title": "Beginning of The Melee",
    "descr": "5500-4900bu. After communications with Earth cease due to the Fall, Karrakis planetary admin officials seize control over the colony. The colony devolves into factions and war.",
    "sources" : [
        {     
            "source": "Field Guide to the Karrakin Trade Baronies",
            "sourceLocation": "pg. 9"
        }
    ]
}

It should be noted that timeline entries are automatically sorted by the React app. The sort order is descending year for entries in the BU era, and ascending year for entries in the U era.

On Contributing

Data

This site's content is populated using the data format outlined under Data Formats, where all data is stored and pulled from src/lancer-timeline-data.json. All data contributions should follow the above data formats and pattern. It should be noted that there is no required ordering of nodes or list items in any of the data structures.

FOR AUTHORS OF PUBLISHED THIRD PARTY CONTENT: This project is more than happy to receive and present any timeline data from people who have published third party content. All entries have sources at the bottom that link to a given source's home or store page.

If the submitter is not the author of the third party content, the submitter will need to present some form of validation that they have received consent from the author, or have the content author contact the admins of this project.

Code

This is my first React app. There are bound to be any number of odd bugs that could be fixed, inefficiencies to be found, and improvements to be made. So what's next, and what am I looking for? Currently, the goals of this project are: simplicity; easy to update data structures; clean and simple user interface; and a snappy response time.

Please keep those things in mind when making suggestions or submitting PRs for feature additions.

Credits

This timeline would not be possible without all of the hard work by Massif Press' Lancer team and the many supporters and third party content creators.

The original design of the timeline is based on the following CodePen: A Pen created on CodePen.io. Original URL: https://codepen.io/MarkBoots/pen/OJOqNyB.

License

This project is licensed under the MIT license.

Legal

Unofficial Lancer Universe Timeline is not an official Lancer product; it is a third party work, and is not affiliated with Massif Press. Unofficial Lancer Universe Timeline is published via the Lancer Third Party License.

Lancer is copyright Massif Press

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 57.2%
  • CSS 34.4%
  • HTML 8.4%