Skip to content

Latest commit

 

History

History
130 lines (111 loc) · 10 KB

README.md

File metadata and controls

130 lines (111 loc) · 10 KB

Logo showing map of Roshar in the background with the title 'Roshar' and subtitle 'Interactive Map & Timeline' overlayed

Build Status Discord 17th Shard Forum Patreon

She trailed off, noticing for the first time that a map covered the table nearby. Expansive, it showed a land bounded by oceans—and the artistry of it put her own attempts to shame.

— Prologue to Oathbringer

An interactive map of Roshar, the world that The Stormlight Archive, a series of epic fantasy books by Brandon Sanderson, takes place on. There are descriptions of every location as well as a navigable timeline of events. Built using Vue.js and three.js.

Features

  • Fully labeled, explorable map of Roshar—including Shadesmar
  • Detailed timeline of the history of Roshar, spanning from pre-history to current events in the published books
  • Summaries of events, locations, and characters including links to related items and further details on the Coppermind Wiki
  • Localized content, currently available in the following languages besides English:
    • Chinese
    • Russian
    • Spanish
  • Layers on top of the map that can be enabled at any time, displaying useful additional information
    • Overlay the borders of the historic Silver Kingdoms
    • Show color indicators of the allegiances of various nations
    • Map out the ten Oathgate locations
  • Powerful filtering and customization capabilities
    • Filter timeline events by tags
    • Display a timeline separately from the rest to identify a single character's or book's events
    • Lock navigation controls to a separate timeline to follow only its events

Contribute

Help is always welcome! There's two main ways of contributing directly to this project: Translations and code. For translations, you may contribute both fixes to existing texts—including English—as well as entirely new locales. Feel free to work on translations in chunks and to ask for help in getting a new language set up on our Discord or forums, especially where localizing the actual map is concerned.

Bug fixes and improvements based on reported issues can be addressed through pull requests if you feel confident to work on the code base. As goes for translations, do not shy away from asking other contributors for pointers on where to start looking.

If you've found a bug or would like to request a feature, please report it on GitHub's issue tracker.

For some more detailed instructions on both translating and developing, follow the contribution guide.

Credits

Obviously this project would not exist without the fantastic books by Brandon Sanderson. The richness of the world allows us to create such a detailed experience.

The following is a list of all the artists that are either official artists or have gracefully granted this project permission to use their pieces as images for events, locations, characters, or other items:

A very special thanks goes out to Reddit user Stoneward13 for letting use and modify his awesome high resolution versions of the Roshar and Shadesmar maps.

We also thank the amazing people at Cosmere.es, The Cosmerenauts, and everyone else in our translation Discord server for going through the monumental effort of translating everything to several other languages, and fixing errors in the English text along the way!

Finally, the general appearance and concept of the map derives heavily from the interactive map of "The Continent" for Netflix's The Witcher series.

License

This project is licensed under the MIT License. Please familiarize yourself with it if you wish to contribute.

⚠️ Note: This license only applies to the code itself. All the artwork used for the map is used and distributed with special permission for the 17th Shard. Furthermore, the names and ideas from The Stormlight Archive are reproduced here in conformance with Brandon Sanderson's fanart policy. See the credits section for further details.