Skip to content

Commit acb86d2

Browse files
author
sourcehold
committed
ci: add website
1 parent 58b4f5b commit acb86d2

8 files changed

Lines changed: 149 additions & 0 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Deploy Sphinx documentation to Pages
2+
3+
on:
4+
workflow_dispatch: {}
5+
push:
6+
paths:
7+
- "docs/**/*"
8+
9+
jobs:
10+
pages:
11+
runs-on: ubuntu-20.04
12+
environment:
13+
name: github-pages
14+
url: ${{ steps.deployment.outputs.page_url }}
15+
permissions:
16+
pages: write
17+
id-token: write
18+
steps:
19+
- id: deployment
20+
uses: sphinx-notes/pages@v3

‎docs/_static/openshc-logo-01.png‎

1.45 MB
Loading

‎docs/conf.py‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
project = 'OpenSHC'
2+
author = 'Sourcehold Team'
3+
release = '0.1'
4+
5+
extensions = [
6+
'sphinx.ext.autodoc',
7+
'sphinx.ext.napoleon',
8+
]
9+
10+
html_theme = 'furo'
11+
12+
html_title = 'OpenSHC Documentation'
13+
html_logo = '_static/openshc-logo-01.png'
14+
html_static_path = ['_static']
15+
html_theme_options = {
16+
"footer_icons": [
17+
{
18+
"name": "GitHub",
19+
"url": "https://github.com/sourcehold/OpenSHC",
20+
"html": """
21+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024" height="1.25em" width="1.25em" xmlns="http://www.w3.org/2000/svg">
22+
<path d="M511.6 76.3C264.6 76.3 64 277.5 64 524.8c0 197.7 128.5 365.4 306.7 424.8 22.4 4.2 30.5-9.7 30.5-21.5 0-10.7-.4-46-0.6-83.6-124.8 27.2-151.2-53.6-151.2-53.6-20.4-52-49.9-65.8-49.9-65.8-40.8-27.8 3-27.2 3-27.2 45.2 3.2 69 46.5 69 46.5 40.1 68.8 105.2 48.9 130.8 37.4 4-29.1 15.7-48.9 28.5-60.2-99.6-11.3-204.4-49.8-204.4-221.6 0-48.9 17.4-88.9 45.8-120.2-4.6-11.3-19.9-56.8 4.3-118.4 0 0 37.5-12 123 45.8 35.7-9.9 74-14.9 112.1-15.1 38 .2 76.4 5.2 112.1 15.1 85.4-57.8 122.8-45.8 122.8-45.8 24.4 61.6 9 107.1 4.4 118.4 28.5 31.3 45.8 71.3 45.8 120.2 0 172.4-105.1 210-204.9 221.2 16.2 14 30.5 41.6 30.5 83.8 0 60.4-0.5 109-0.5 123.8 0 11.9 8 25.9 30.7 21.5C831.6 890 960 722.3 960 524.8 960 277.5 759.6 76.3 511.6 76.3z"></path>
23+
</svg>
24+
""",
25+
"class": "",
26+
},
27+
],
28+
"source_repository": "https://github.com/sourcehold/OpenSHC/",
29+
"source_branch": "main",
30+
"source_directory": "docs/",
31+
}
32+
33+
html_context = {
34+
"copyright": "Copyright 2025 OpenSHC",
35+
}
36+
37+
templates_path = ['_templates']
38+
exclude_patterns = []

‎docs/contributing.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Contributing to OpenSHC
2+
=======================
3+
4+
Ready to dive in? Here's how you can start contributing to OpenSHC.
5+
6+
1. **Clone the Repository**
7+
8+
```bash
9+
git clone https://github.com/sourcehold/OpenSHC.git
10+
cd OpenSHC
11+
```
12+
13+
2. **Install Dependencies**
14+
15+
Make sure you have the required libraries:
16+
17+
- Python
18+
- `MSVC 1400 <https://github.com/sourcehold/MSVC1400>`_
19+
20+
3. **Build the Project**
21+
22+
Open a prompt and load the MSVC 1400 environment (.bat file)
23+
24+
```bash
25+
mkdir build && cd build
26+
cmake .. -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=%1
27+
nmake
28+
```
29+
30+
4. **Run reccmp**
31+
This compares
32+
```bash
33+
reccmp-reccmp --paths "path\to\Stronghold Crusader.exe" build\OpenSHC.dll build\OpenSHC.pdb . %2 %3
34+
```
35+

‎docs/get_started.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Getting Started
2+
===============
3+
4+
Ready to dive in? Here's how you can start playing with OpenSHC.
5+
6+
The current method of installation is via the `Unofficial Crusader Patch <https://github.com/UnofficialCrusaderPatch/UnofficialCrusaderPatch>`_. Make sure to set that up first.
7+
8+
#. Set up the Unofficial Crusader Patch.
9+
10+
#. Download the latest release of the reimplementation from the Releases `page <https://github.com/sourcehold/OpenSHC/releases>`_.
11+
12+
#. Launch the GUI from the Unofficial Crusader Patch.
13+
14+
#. Drag and drop the zip file unto your open UCP3 GUI, or manually move the zip file into the `ucp/modules` folder inside your game folder.
15+
16+
#. Reload the UCP3 GUI and activate the module.
17+
18+
#. Disable Security in the Launch tab of the GUI.
19+
20+
#. Launch the game!

‎docs/index.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. OpenSHC documentation master file, created by sphinx-quickstart
2+
3+
Welcome to OpenSHC!
4+
===================
5+
6+
**OpenSHC** is an open-source reimplementation of the beloved classic game
7+
**Stronghold Crusader** by Firefly Studios. Our goal is to recreate the gameplay,
8+
mechanics, and feel of the original, while making the codebase modern, moddable,
9+
and accessible to everyone.
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
:caption: Contents:
14+
15+
get_started
16+
wiki
17+
contributing
18+

‎docs/requirements-docs.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
furo
2+
sphinx

‎docs/wiki.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
Wiki
3+
====
4+
5+
Welcome to the OpenSHC Wiki!
6+
7+
Here you'll find detailed documentation about:
8+
9+
- Game Mechanics
10+
- AI Behavior
11+
- Graphics and Sound Systems
12+
- Modding Support
13+
- Multiplayer Architecture
14+
15+
(Coming Soon!)
16+

0 commit comments

Comments
 (0)