Skip to content

Commit

Permalink
Update wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikk155 committed Mar 6, 2024
1 parent 00c0eb7 commit b6d3dac
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 100 deletions.
100 changes: 0 additions & 100 deletions docs/README.md

This file was deleted.

28 changes: 28 additions & 0 deletions docs/branches.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="styles.css">
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script> mermaid.initialize({ startOnLoad: true }); </script>
</head>

<body>
<p>Branches inheritance graphic</p>

<div class="mermaid">
graph TD;

classDef color_purple fill:#b12bda;

fork_upstream{{"halflife-unified up-stream"}}:::color_purple

fork_master{{"master"}}:::color_purple

fork_usetype{{"Use Type"}}:::color_purple
fork_upstream --> fork_usetype --> fork_master

fork_inheritkv{{"inherit keyvalues"}}:::color_purple
fork_upstream --> fork_inheritkv --> fork_master
</div>
</body>
</html>
63 changes: 63 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Unified SDK documentation</title>
<link rel="stylesheet" href="styles.css">
</head>

<body>
<h1>Limitless Potential documentation</h1>

<h2><a href="entities.html">Entity guide</a></h2>

<h2><a href="branches.html">Branches inheritance graphic</a></h2>

<h1>Unified SDK documentation</h1>

<p>The files in this directory and subdirectories contain documentation for the Unified SDK as well as tutorials<br>
and resources. Please check them before asking for help.</p>

<blockquote>
<span style="background-color:orange; color: black">Warning</span><br>
<span style="background-color:orange; color: black">Due to how some SDK features are implemented demos will not work
properly. Use an external program like OBS to record the game.</span>
</blockquote>

<blockquote>
<span style="background-color:darkseagreen; color: black">Note</span><br>
<span style="background-color:darkseagreen; color: black">Maps made for the original games need to be upgraded
using the MapUpgrader tool before they can be played in this mod.</span>
</blockquote>

<h2>Developer Resources</h2>
<ul>
<a href="https://github.com/twhl-community/halflife-unified-sdk">SDK Source Code<br></a> (Source code for mods and original SDK tools)<br><br>
<a href="dotnet-tools.md">.NET Tools</a><br><br>
<a href="https://github.com/twhl-community/halflife-unified-sdk-assets">Asset Source Files</a><br><br>
<a href="https://github.com/twhl-community/HalfLife.UnifiedSdk-CSharp">C# Tools Source Code<br></a> (Source code for new tools written in C#)<br><br>
<a href="https://github.com/twhl-community/halflife-unified-sdk/releases">Releases<br></a> (Game installation package)<br><br>
<a href="https://github.com/twhl-community/halflife-unified-sdk/actions">Github Actions<br></a> (Automated builds, pre-built binaries for Windows and Linux)<br><br>
<a href="https://github.com/twhl-community/HalfLife.UnifiedSdk.MapDecompiler">Map Decompiler<br></a> (Note: GPLv2-licensed)
</ul>

<h2>Other Source Code Repositories</h2>
<ul>
<a href="https://github.com/twhl-community/halflife-updated">Half-Life Updated<br></a>
<a href="https://github.com/twhl-community/halflife-op4-updated">Half-Life: Opposing Force Updated<br></a>
<a href="https://github.com/twhl-community/halflife-bs-updated">Half-Life: Blue Shift Updated<br></a>
<a href="https://github.com/twhl-community/dmc-updated">DMC Updated<br></a>
<a href="https://github.com/twhl-community/ricochet-updated">Ricochet Updated</a>
</ul>

<h2>Core Features</h2>
<ul>
<a href="features/string-pool.md">String pool<br></a>
<a href="features/json-system.md">JSON system</a>
</ul>

</body>

</html>
1 change: 1 addition & 0 deletions scripts/ParseEntityData.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Crear entities.html al final cuando todo este completo
# Ordenar alfabeticamente
# Separar por Class en carpeta point/ y solid/
# mb replace \n -> <br>

import json

Expand Down

0 comments on commit b6d3dac

Please sign in to comment.