Terasology/docs/Project-Overview.md
Tobias Nett 2d8ef61e80
doc: move wiki content to docsify page (#5155)
* rename docs to docs-pre-merge
* add wiki content based on commit e4d4b10424f24eed6583ea0e998da8aa32a27a3f
* replace wikilinks with markdown links in _sidebar
* use sidebar link text as title via ` autoHeader: true` 
* rename files with `:` or `,` in the name
* use the wiki Home page as entry point instead of the repo README
2023-10-31 14:46:35 +01:00

4.4 KiB

This is a overview of all the involved sites, GitHub repositories and related projects that are involved with Terasology

Sites

Our online presence covers:

  • Portal / forum - main site for announcements and discussion
  • Meta Server - shows a list of game servers, modules, and so on. Can be used via API and is used as such by the game and launcher.
  • Splash Site - a small GitHub Page (hosted here to intro the game, play via applet, or even run the soundtrack (top left - Flash)
  • Note: Both applets and flash are aging as technologies and may not work in some browsers due to support and security. Goal is to eventually replace with Java Webstart and HTML5.
  • Social networks: Reddit | Facebook | Twitter | G+

Primary Repositories

The central components of Terasology live under two GitHub Organizations. The ones needed to run the base game are listed below.

See Codebase Structure for more details on each piece

  • MovingBlocks - this organization primarily contains the engine itself plus facades. It also holds some library projects - more below
    • Engine: The beating heart of the game. Also contains the PC Facade (the standard application) and the Core Module, as they're required for the base game to run normally
  • Terasology - this organization is entirely meant for hosting content modules. These come in two flavors
    • Root repos: Modules that follow the full Contributor Guidelines and may be maintained to some degree by the official community
    • Fork repos: Modules hosted by modders elsewhere on GitHub that follow the Modder Guidelines and are eligible for inclusion in official distributions and the launcher

Libraries

We've created some library projects while working on Terasology that are used in-game

Other projects

These are indirect parts of the project, such as our supporting site work and launcher

  • Launcher - the best way to run the game. Allows easy auto-updating and managing different versions of the game
  • Applet - the Facade running the applet version of the game you can play in your browser
  • Splash Site - our GitHub-hosted front-end site at http://terasology.org offering a few quick links and what not - just in case our primary site gets slammed or something :-)
  • Gooey - our handy little Hubot-based IRC bot offering witty banter and useful functionality like auto-creating GitHub repos. When he feels like it, anyway!
  • TeraMisc - a repository for miscellaneous stuff that doesn't really fit anywhere else. Like raw model files, assorted utility scripts, stuff for our XenForo site (forum/portal)

External projects

These are noteworthy external projects we use