diff --git a/docs/Home.md b/docs/Home.md index 290db444805..d8822a9490f 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -1,58 +1,50 @@ -Welcome to the Terasology Wiki! +# Welcome to Terasology! -This is a wiki for those interested in contributing to the development of the project. +🌟 **Embark on an open-source adventure** where you can contribute, play, and explore the world of Terasology. -It doesn't cover game content or how to play the game much, but check out the docs on [Playing](https://github.com/MovingBlocks/Terasology/blob/develop/docs/Playing.md) (including hotkeys etc) and [Modules](https://github.com/MovingBlocks/Terasology/blob/develop/docs/Modules.md) for some of that. +Discover a diverse range of Terasology resources within this wiki, encompassing various aspects of the game. For detailed game content, comprehensive gameplay guidance, developer resources, and dedicated information on related topics, navigate to specific sections provided here. -Use the sidebar to arrive at the most central topics this wiki covers. +## Quick Links -See [What is Terasology](What-is-Terasology.md) for some more background information. +- **[🎮 Players](https://github.com/MovingBlocks/Terasology/blob/develop/docs-pre-merge/Playing.md)** - For Players +- **[🏗️ Developer's Hub](Contributor-Quick-Start.md)** - For Developers +- **[🛠️ Maintainer's Dashboard](Maintenance.md)** - For Maintainers -## Joining the Community & Asking for Help -Our main place of communication is on our [Discord Server](https://discord.gg/terasology). -Make sure to check in, introduce yourself and what you're interested in with regards to Terasology :wave: -For any playing related issues, leave us a note in the `#play-terasology` channel. -Troubleshooting workspace setup, compile / test issues or other development related issues can be raised in the `#terasology` channel or by [opening an issue on this repo](https://github.com/MovingBlocks/Terasology/issues/new/choose). -Our [forum](https://forum.terasology.org/forum/) is currently mainly used to track progress of our GSoC student projects. -However, it has a lot of more or less actionable ideas for improvement and a bunch of history of our current gameplays floating around, so feel free to roam around a bit and get inspired :wink: +## Understanding Terasology -## Contributing +Terasology itself is a pure sandbox. Gameplay is implemented through modules, which can add anything from new blocks and crafting methods to entirely new game modes. -Interested in getting involved with working on the game? Make sure to check out the [Contributor Quick Start](Contributor-Quick-Start.md) for setting up your first workspace and starting the game from source. It also has useful links on how to start with your first contribution. +- 🏛️ **[Architecture Overview](Codebase-Structure.md)** + - Understand the high-level structure of the project. +- 🔧 **[Entity System Architecture](Entity-System-Architecture.md)** + - Dive into how our entity system powers the game. +- 🎲 **[Events and Systems](Events-and-Systems.md)** + - Explore how to inject new logic and life into the game. +- 🏗️ **[Block Architecture](https://github.com/Terasology/TutorialAssetSystem/wiki/Block-Attributes)** + - Delve into the building blocks of the game world. -We also apply for GSOC - [Google Summer of Code](https://developers.google.com/open-source/gsoc) and [GCI](GCI.md) - [Google Code-In](https://codein.withgoogle.com/) every year. So if you're a student and it is that time of the year maybe check it out! +## Core and Libraries + - This core is backed by several in-house libraries, such as [MovingBlocks/gestalt](https://github.com/MovingBlocks/gestalt), providing the entity system and module management, or our own UI library [MovingBlocks/TeraNUI](https://github.com/MovingBlocks/TeraNUI). + - The actual game content is added by modules on top of that. -## Architecture -Terasology is build from many building bricks, that together turn into a game. +### Getting Help and Support -The _engine_ forms the core, and resides alongside the default _facade_ and _subsystems_ in ([MovingBlocks/Terasology](https://github.com/MovingBlocks/Terasology)). +- If you believe you've found a bug, please create an issue on GitHub [open an issue on GitHub](https://github.com/MovingBlocks/Terasology/issues/new/choose). -This core is backed by several in-house _libraries_, such as([MovingBlocks/gestalt](https://github.com/MovingBlocks/gestalt)) providing the entity system and module management, or our own UI library ([MovingBlocks/TeraNUI](https://github.com/MovingBlocks/TeraNUI)). -The actual game content is added by _modules_ on top of that. -All Terasology modules reside in the [Terasology](https://github.com/Terasology) Github organization. +## Troubleshooting -![Terasology - High Level Architecture](architecture.png) - -These pages offer more advanced insight into how specific features of the game are architected and why. - -- [Project Sturcture](Codebase-Structure.md) - a high-level overview of the code base -- [Entity System Architecture](Entity-System-Architecture.md) - describes the structure and usage of the entity system. -- [Events and Systems](Events-and-Systems.md) - describes how new game logic can be hooked in -- [Block Architecture](https://github.com/Terasology/TutorialAssetSystem/wiki/Block-Attributes) - development overview of our Block system. (pending changes needed to make the game work in an applet again) -- [Block Shapes](Block-Shapes.md) - defining 3D meshes via definitions in JSON! +Encountering issues? Our [Troubleshooting guide](Troubleshooting.md) offers solutions for common problems faced by players and developers alike. ## Announcement Channels -We have several ways to get the word out on updates, likewise, there are several ways to contact us. - -- [Discord](https://discordapp.com/invite/terasology) - New development/game topics will be posted in `#announcement`, and any questions answered. -- [GitHub (Engine)](https://github.com/MovingBlocks/Terasology) - "Watch" the official project here to be able to easily spot core commits and changes. -- [GitHub (Modules)](https://github.com/Terasology) - "Watch" the module repos to be able to keep track of game content fixes / changes. -- [Forum](http://forum.terasology.org/) - Find the progress reports of ongoing and past GSoC projects along with a lot of gameplay ideas and lore -- [Twitter](http://twitter.com/#!/Terasology) - We'll tweet regularly about significant commits or new discussion topics posted, so "Follow" us for updates. -- [Facebook](http://www.facebook.com/pages/Terasology/248329655219905) - If you prefer to keep updated via Facebook you can "Like" us on there to keep up. -- [Jenkins RSS](http://jenkins.terasology.org/rssAll) - If you really want to know when something has just been built ;-) +- **[Discord](https://discordapp.com/invite/terasology)** - for discussion and general support. +- **[GitHub (Engine)](https://github.com/MovingBlocks/Terasology)** - Watch the engine or modules for real-time updates. +- **[GitHub (Modules)](https://github.com/Terasology)** - Watch the module repos for game content fixes / changes. +- **[Forum](http://forum.terasology.org/)** - Find the progress reports of ongoing and past GSoC projects +- **[Twitter](http://twitter.com/#!/Terasology)** - Follow for tweet-sized news. +- **[Facebook](http://www.facebook.com/pages/Terasology/248329655219905)** - Like us for updates in your feed. +- **[Jenkins RSS](http://jenkins.terasology.io/rssAll)** - For the keen observers of new builds. diff --git a/docs/index.html b/docs/index.html index f0b9a48490f..eae12dd843a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,59 +1,69 @@ + + + Terasology - Knowledge Base + + + + + + + - - - Terasology - Knowledge Base - - - - - - - - -
- - - - - - - - - - - - + +
+ + + + + + + + + + + diff --git a/docs/styles.css b/docs/styles.css new file mode 100644 index 00000000000..83d090475cc --- /dev/null +++ b/docs/styles.css @@ -0,0 +1,4 @@ +.app-name img { + max-width: 70%; + height: auto; + } \ No newline at end of file