.. Prism documentation master file, created by
   sphinx-quickstart on Sun Apr  6 16:41:35 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Prism
=====

A comprehensive traditional roguelike engine, built on top of `LÖVE <https://love2d.org/>`_.

Getting started
---------------

Check out :doc:`the tutorial <making-a-roguelike/part1>` for a guided walk-through
of creating a game, or just :doc:`install prism <installation>` and start hacking away.

"Traditional" roguelike?
------------------------

Prism is geared towards classic roguelike games like `NetHack <https://www.nethack.org/>`_ or 
`Brogue <https://sites.google.com/site/broguegame/>`_, turn-based games set in randomly generated grid levels. 
Other turn-based tactics games might also be a good fit.

Community
---------

Our discord can be found `here <https://discord.gg/9YpsH4hYVF>`_.

.. toctree::
   :hidden:

   installation
   architecture-primer
   conventions

.. toctree::
   :caption: How-tos
   :glob:
   :hidden:

   how-tos/object-registration
   how-tos/query
   how-tos/*

.. toctree::
   :caption: Making a roguelike
   :hidden:

   making-a-roguelike/part1
   making-a-roguelike/part2
   making-a-roguelike/part3
   making-a-roguelike/part4
   making-a-roguelike/part5
   making-a-roguelike/part6
   making-a-roguelike/part7
   making-a-roguelike/part8
   making-a-roguelike/part9

.. toctree::
   :caption: Explainers
   :hidden:
   :glob:

   explainers/*

.. toctree::
   :caption: Reference
   :hidden:

   reference/prism/index
   reference/spectrum/index
   reference/extra/index