HEModdingWiki:Style guide: Difference between revisions

Revision as of 15:20, 21 January 2025

While HEModdingWiki is an open library anyone can contribute to, some direction is generally needed to keep a consistent style and structure on the wiki. This page outlines some general guidelines on how to structure pages and what writing style to maintain when contributing to the wiki. This page has been protected because any changes to it should be collectively discussed. If you would like to amend this page, please open a topic in the discussion section.

General structure of the wiki

We identify the following classes of topics:

Technical topics
- General technical modding topics: Rendering/PBR Rendering, Sebastien Atmosphere Rendering, Texture compression formats, ...
- Technical topics related to any Hedgehog Engine version: Paths, Set objects, SurfRide, Cyan, ...
- Technical topics related to a specific Hedgehog Engine version: HE2/ObjectWorld, HE2/Scene Parameters, ...
- Technical topics related to a specific game: Sonic Frontiers/NeedleFxSceneData, Sonic Forces/Avatar editor, ...

Guides
- General modding guides: Compressing textures to DXT, Retopology with Blender, Creating CRIware ACBs, ...
- Guides related to modding any Hedgehog Engine version: Converting a model to ResModel, Porting stages using HSON, ...
- Guides related to modding a specific Hedgehog Engine version.
- Guides related to modding a specific game: Creating new cyberspace portals, Adding Werehog abilities, ...

General Information
- Information about modding tools: HedgeSet, Blendhog Level Creator, ...

Currently we strive to maintain the following URL structure to place these topics:

/
├ General technical modding topics
├ Technical topics related to any Hedgehog Engine version
├ /Guides
│ ├ General modding guides
│ └ Guides related to modding any Hedgehog Engine version
├ /Tools
│ └ Information about modding tools
├ /<engine name, HE1 or HE2>
│ ├ Technical topics related to a specific Hedgehog Engine version
│ ├ /Guides
│   └ Guides related to modding a specific Hedgehog Engine version
├ /<game name>
│ └ Technical topics related to a specific game
└ /Guides
  └ Guides related to modding a specific game

@@ Line 22: / Line 22: @@
   /
-  |-> General technical modding topics
+  ├ General technical modding topics
-  |-> Technical topics related to any Hedgehog Engine version
+  ├ Technical topics related to any Hedgehog Engine version
-  |-> /Guides
+  ├ /Guides
-  |   |-> General modding guides
+  │ ├ General modding guides
-  |   |-> Guides related to modding any Hedgehog Engine version
+  │ └ Guides related to modding any Hedgehog Engine version
-  |-> /Tools
+  ├ /Tools
-  |   |-> Information about modding tools
+  │ └ Information about modding tools
-  |-> /<engine name, HE1 or HE2>
+  ├ /<engine name, HE1 or HE2>
-  |   |-> Technical topics related to a specific Hedgehog Engine version
+  │ ├ Technical topics related to a specific Hedgehog Engine version
-  |   |-> /Guides
+  │ ├ /Guides
-  |       |-> Guides related to modding a specific Hedgehog Engine version
+  │   └ Guides related to modding a specific Hedgehog Engine version
-  |-> /<game name>
+  ├ /<game name>
-  |   |-> Technical topics related to a specific game
+  │ └ Technical topics related to a specific game
-  |-> /Guides
+  └ /Guides
-     |-> Guides related to modding a specific game
+   └ Guides related to modding a specific game