Skip to content

Commit 2b57f51

Browse files
committed
sphinx theme furo
1 parent 6a89c79 commit 2b57f51

File tree

7 files changed

+24
-13
lines changed

7 files changed

+24
-13
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
# uwapi
22
Language bindings for writing AI bots and scripts for Unnatural Worlds.
3+
4+
Documentation is at: https://unnatural-worlds.github.io/uwapi/

sphinx/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
sphinx_design
2+
furo

sphinx/source/bots/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@ The uwapi repository contains c/c++ headers for all functions and structures pro
88

99
The uwapi repository also contains convenient wrappers for Python and for C# for quicker start of writing your bot.
1010

11+
The bots api is designed such that you retain full control over your bot program - aka it makes it possible to develop and debug it the way you are used to.
12+
However, to be able to start the game outside of the Steam, it is necessary to copy the file ``steam_appid.txt`` (contained in the uwapi repository) into the ``bin`` folder, next to the game executable.
13+
This also allows you to start the game, and all other accompanying programs, from command line or from bash, which allows you to manually start the server, and connect any number of bots and human players.
14+
1115
.. toctree::
1216
troubleshooting

sphinx/source/bots/troubleshooting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Troubleshooting
88

99
Make sure you have installed Unnatural Worlds in Steam.
1010

11-
If your Steam games are in a non-default location, define the environment variable ``UNNATURAL_ROOT`` to the directory containing the library.
11+
If your Steam games are in non-default location, define the environment variable ``UNNATURAL_ROOT`` to the directory containing the library.
1212
Example: ``C:\Program Files (x86)\Steam\steamapps\common\Unnatural Worlds\bin``
1313

1414
.. dropdown:: OSError: cannot load library 'unnatural-uwapi-hard'
1515

1616
Make sure you have installed Unnatural Worlds in Steam.
1717

18-
If your Steam games are in a non-default location, define the environment variable ``UNNATURAL_ROOT`` to the directory containing the library.
18+
If your Steam games are in non-default location, define the environment variable ``UNNATURAL_ROOT`` to the directory containing the library.
1919
Example: ``C:\Program Files (x86)\Steam\steamapps\common\Unnatural Worlds\bin``
2020

2121
.. dropdown:: Failed to initialize Steam API

sphinx/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

9-
project = 'uwapi'
9+
project = 'UW api'
1010
copyright = '2025, Tomáš Malý'
1111
author = 'Tomáš Malý'
1212

@@ -29,5 +29,5 @@
2929
# -- Options for HTML output -------------------------------------------------
3030
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3131

32-
html_theme = 'alabaster'
32+
html_theme = 'furo'
3333
html_static_path = ['_static']

sphinx/source/index.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@ Documentation for user-generated content for the game Unnatural Worlds.
99
All user-generated content requires full version of the game.
1010
It will not work with the Demo.
1111

12+
Useful Links
13+
------------
14+
- `Steam Page <https://store.steampowered.com/app/2369780/Unnatural_Worlds/>`_
15+
- `Steam Workshop <https://steamcommunity.com/app/2369780/workshop/>`_
16+
- `Discord <https://discord.gg/RjHFk3vQYG>`_
17+
- `Reddit <https://www.reddit.com/r/unnaturalworlds/>`_
18+
- `Github <https://github.com/unnatural-worlds>`_
19+
- `UW Homepage <https://unnaturalworlds.com/>`_
20+
21+
Index
22+
-----
1223
.. toctree::
1324
:maxdepth: 2
1425

@@ -17,12 +28,3 @@ Documentation for user-generated content for the game Unnatural Worlds.
1728
mods/index
1829
scripts/index
1930
bots/index
20-
21-
External Links
22-
--------------
23-
- `Steam Page <https://store.steampowered.com/app/2369780/Unnatural_Worlds/>`_
24-
- `Steam Workshop <https://steamcommunity.com/app/2369780/workshop/>`_
25-
- `Discord <https://discord.gg/RjHFk3vQYG>`_
26-
- `Reddit <https://www.reddit.com/r/unnaturalworlds/>`_
27-
- `Github <https://github.com/unnatural-worlds>`_
28-
- `Homepage <https://unnaturalworlds.com/>`_

sphinx/source/maps/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Guide on making custom maps for Unnatural Worlds.
88
A map for UW is a collection of assets, and some additional required files.
99
It may contain :ref:`prototypes <Prototypes>`, :ref:`scripts <Scripts>`, models, sounds, etc.
1010

11+
Assets found in a map have precedence over assets in the base game.
12+
1113
Additional files in the map
1214
---------------------------
1315
.. toctree::

0 commit comments

Comments
 (0)