Skip to content

Commit 7cb98ee

Browse files
Legendaryswordsman2Legendaryswordsman2
committed
deploy: 82fc7b5 
1 parent 0f2a1ed commit 7cb98ee

14 files changed

+395
-57
lines changed

‎api/BlazerTech.CharacterManagement.Characters.CharacterTypeBaseSO.html

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8989

9090

9191
<h1 id="BlazerTech_CharacterManagement_Characters_CharacterTypeBaseSO" data-uid="BlazerTech.CharacterManagement.Characters.CharacterTypeBaseSO" class="text-break">
92-
Class CharacterTypeBaseSO <a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L6"><i class="bi bi-code-slash"></i></a>
92+
Class CharacterTypeBaseSO <a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L11"><i class="bi bi-code-slash"></i></a>
9393
</h1>
9494

9595
<div class="facts text-secondary">
@@ -140,10 +140,13 @@ <h2 class="section" id="properties">Properties
140140

141141
<h3 id="BlazerTech_CharacterManagement_Characters_CharacterTypeBaseSO_BaseSpritesheet" data-uid="BlazerTech.CharacterManagement.Characters.CharacterTypeBaseSO.BaseSpritesheet">
142142
BaseSpritesheet
143-
<a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L11"><i class="bi bi-code-slash"></i></a>
143+
<a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L24"><i class="bi bi-code-slash"></i></a>
144144
</h3>
145145

146-
<div class="markdown level1 summary"></div>
146+
<div class="markdown level1 summary"><p>Defines the <strong>required base sprite sheet</strong> for the character type.<br>
147+
Set this spritesheets <strong><code>Sprite Mode</code></strong> to <strong><code>Multiple</code></strong> and slice it. Whenever this character is used the sprites in the <code>BaseSpritesheet</code> will be used and a shader will then override them with the finalized character.
148+
Character spritesheets with mismatched dimensions will be rejected when validated.</p>
149+
</div>
147150
<div class="markdown level1 conceptual"></div>
148151

149152
<div class="codewrapper">
@@ -171,10 +174,12 @@ <h4 class="section">Property Value</h4>
171174

172175
<h3 id="BlazerTech_CharacterManagement_Characters_CharacterTypeBaseSO_CharacterController" data-uid="BlazerTech.CharacterManagement.Characters.CharacterTypeBaseSO.CharacterController">
173176
CharacterController
174-
<a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L14"><i class="bi bi-code-slash"></i></a>
177+
<a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L31"><i class="bi bi-code-slash"></i></a>
175178
</h3>
176179

177-
<div class="markdown level1 summary"></div>
180+
<div class="markdown level1 summary"><p>The animator controller asset assigned to characters of this type.<br>
181+
Animations inside this controller should use sprites in the <a class="xref" href="BlazerTech.CharacterManagement.Characters.CharacterTypeBaseSO.html#BlazerTech_CharacterManagement_Characters_CharacterTypeBaseSO_BaseSpritesheet">BaseSpritesheet</a>.</p>
182+
</div>
178183
<div class="markdown level1 conceptual"></div>
179184

180185
<div class="codewrapper">
@@ -202,10 +207,11 @@ <h4 class="section">Property Value</h4>
202207

203208
<h3 id="BlazerTech_CharacterManagement_Characters_CharacterTypeBaseSO_CharacterTypeID" data-uid="BlazerTech.CharacterManagement.Characters.CharacterTypeBaseSO.CharacterTypeID">
204209
CharacterTypeID
205-
<a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L8"><i class="bi bi-code-slash"></i></a>
210+
<a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L16"><i class="bi bi-code-slash"></i></a>
206211
</h3>
207212

208-
<div class="markdown level1 summary"></div>
213+
<div class="markdown level1 summary"><p>A <strong>unique identifier</strong> used to reference this character type. <strong>Must be unique</strong> across all character types.</p>
214+
</div>
209215
<div class="markdown level1 conceptual"></div>
210216

211217
<div class="codewrapper">
@@ -237,7 +243,7 @@ <h2 class="section" id="methods">Methods
237243

238244
<h3 id="BlazerTech_CharacterManagement_Characters_CharacterTypeBaseSO_IsValidCharacterSpriteSheet_UnityEngine_Sprite_" data-uid="BlazerTech.CharacterManagement.Characters.CharacterTypeBaseSO.IsValidCharacterSpriteSheet(UnityEngine.Sprite)">
239245
IsValidCharacterSpriteSheet(Sprite)
240-
<a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L23"><i class="bi bi-code-slash"></i></a>
246+
<a class="header-action link-secondary" title="View source" href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L39"><i class="bi bi-code-slash"></i></a>
241247
</h3>
242248

243249
<div class="markdown level1 summary"><p>Returns true if the sprite fits the conditions for the Character Type</p>
@@ -274,7 +280,7 @@ <h4 class="section">Returns</h4>
274280
</article>
275281

276282
<div class="contribution d-print-none">
277-
<a href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L6" class="edit-link">Edit this page</a>
283+
<a href="https://github.com/Legendaryswordsman2/BlazerTech-Character-Management-System/blob/main/Assets/BlazerTech Character Management System/Scripts/Scriptable Objects/Character Types/CharacterTypeBaseSO.cs/#L11" class="edit-link">Edit this page</a>
278284
</div>
279285

280286

‎api/BlazerTech.CharacterManagement.Characters.EquippedCharacterPiece.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="title" content="Class EquippedCharacterPiece | BlazerTech Character Management System ">
88

9-
<meta name="description" content="A wrapper for . used as a list in">
9+
<meta name="description" content="A wrapper for . used as a list in .">
1010
<link rel="icon" href="../favicon.ico">
1111
<link rel="stylesheet" href="../public/docfx.min.css">
1212
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,7 @@ <h1 id="BlazerTech_CharacterManagement_Characters_EquippedCharacterPiece" data-u
9797
<dl><dt>Assembly</dt><dd>Assembly-CSharp.dll</dd></dl>
9898
</div>
9999

100-
<div class="markdown summary"><p>A wrapper for <a class="xref" href="BlazerTech.CharacterManagement.Characters.CharacterPieceDefinition.html">CharacterPieceDefinition</a>. used as a list in <a class="xref" href="BlazerTech.CharacterManagement.Characters.LayeredCharacter.html">LayeredCharacter</a></p>
100+
<div class="markdown summary"><p>A wrapper for <a class="xref" href="BlazerTech.CharacterManagement.Characters.CharacterPieceDefinition.html">CharacterPieceDefinition</a>. used as a list in <a class="xref" href="BlazerTech.CharacterManagement.Characters.LayeredCharacter.html">LayeredCharacter</a>.</p>
101101
</div>
102102
<div class="markdown conceptual"></div>
103103

‎api/BlazerTech.CharacterManagement.Characters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ <h3 id="classes">
153153
</dl>
154154
<dl class="jumplist">
155155
<dt><a class="xref" href="BlazerTech.CharacterManagement.Characters.EquippedCharacterPiece.html">EquippedCharacterPiece</a></dt>
156-
<dd><p>A wrapper for <a class="xref" href="BlazerTech.CharacterManagement.Characters.CharacterPieceDefinition.html">CharacterPieceDefinition</a>. used as a list in <a class="xref" href="BlazerTech.CharacterManagement.Characters.LayeredCharacter.html">LayeredCharacter</a></p>
156+
<dd><p>A wrapper for <a class="xref" href="BlazerTech.CharacterManagement.Characters.CharacterPieceDefinition.html">CharacterPieceDefinition</a>. used as a list in <a class="xref" href="BlazerTech.CharacterManagement.Characters.LayeredCharacter.html">LayeredCharacter</a>.</p>
157157
</dd>
158158
</dl>
159159
<dl class="jumplist">

‎docs/Essentials/character-creator.html

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Character Creator | BlazerTech Character Management System </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Character Creator | BlazerTech Character Management System ">
8+
9+
10+
<link rel="icon" href="../../favicon.ico">
11+
<link rel="stylesheet" href="../../public/docfx.min.css">
12+
<link rel="stylesheet" href="../../public/main.css">
13+
<meta name="docfx:navrel" content="../../toc.html">
14+
<meta name="docfx:tocrel" content="../toc.html">
15+
16+
<meta name="docfx:rel" content="../../">
17+
18+
19+
<meta name="docfx:docurl" content="https://github.com/Legendaryswordsman2/BT-Character-Management-System-Docs/blob/main/docs/Essentials/character-creator.md/#L1">
20+
<meta name="loc:inThisArticle" content="In this article">
21+
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
22+
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
23+
<meta name="loc:tocFilter" content="Filter by title">
24+
<meta name="loc:nextArticle" content="Next">
25+
<meta name="loc:prevArticle" content="Previous">
26+
<meta name="loc:themeLight" content="Light">
27+
<meta name="loc:themeDark" content="Dark">
28+
<meta name="loc:themeAuto" content="Auto">
29+
<meta name="loc:changeTheme" content="Change theme">
30+
<meta name="loc:copy" content="Copy">
31+
<meta name="loc:downloadPdf" content="Download PDF">
32+
33+
<script type="module" src="./../../public/docfx.min.js"></script>
34+
35+
<script>
36+
const theme = localStorage.getItem('theme') || 'auto'
37+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
38+
</script>
39+
40+
</head>
41+
42+
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
43+
<header class="bg-body border-bottom">
44+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
45+
<div class="container-xxl flex-nowrap">
46+
<a class="navbar-brand" href="../../index.html">
47+
<img id="logo" class="svg" src="../../logo.svg" alt="BlazerTech Character Management System">
48+
BlazerTech Character Management System
49+
</a>
50+
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
51+
<i class="bi bi-three-dots"></i>
52+
</button>
53+
<div class="collapse navbar-collapse" id="navpanel">
54+
<div id="navbar">
55+
<form class="search" role="search" id="search">
56+
<i class="bi bi-search"></i>
57+
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
58+
</form>
59+
</div>
60+
</div>
61+
</div>
62+
</nav>
63+
</header>
64+
65+
<main class="container-xxl">
66+
<div class="toc-offcanvas">
67+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
68+
<div class="offcanvas-header">
69+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
70+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
71+
</div>
72+
<div class="offcanvas-body">
73+
<nav class="toc" id="toc"></nav>
74+
</div>
75+
</div>
76+
</div>
77+
78+
<div class="content">
79+
<div class="actionbar">
80+
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
81+
<i class="bi bi-list"></i>
82+
</button>
83+
84+
<nav id="breadcrumb"></nav>
85+
</div>
86+
87+
<article data-uid="character-creator">
88+
<h1 id="character-creator">Character Creator</h1>
89+
90+
91+
</article>
92+
93+
<div class="contribution d-print-none">
94+
<a href="https://github.com/Legendaryswordsman2/BT-Character-Management-System-Docs/blob/main/docs/Essentials/character-creator.md/#L1" class="edit-link">Edit this page</a>
95+
</div>
96+
97+
<div class="next-article d-print-none border-top" id="nextArticle"></div>
98+
99+
</div>
100+
101+
<div class="affix">
102+
<nav id="affix"></nav>
103+
</div>
104+
</main>
105+
106+
<div class="container-xxl search-results" id="search-results"></div>
107+
108+
<footer class="border-top text-secondary">
109+
<div class="container-xxl">
110+
<div class="flex-fill">
111+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
112+
</div>
113+
</div>
114+
</footer>
115+
</body>
116+
</html>

‎docs/character-types.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8484
<nav id="breadcrumb"></nav>
8585
</div>
8686

87-
<article data-uid="">
87+
<article data-uid="character-types">
8888
<h1 id="character-types">Character Types</h1>
8989

9090
<p>Character Types are <a href="https://docs.unity3d.com/6000.0/Documentation/Manual/class-ScriptableObject.html">Scriptable Objects</a> that define core aspects of a character. They are the heart of the Character Management System.</p>

‎docs/getting-started/basic-concepts.html

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<html>
33
<head>
44
<meta charset="utf-8">
5-
<title>Customization | BlazerTech Character Management System </title>
5+
<title>Basic Concepts | BlazerTech Character Management System </title>
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7-
<meta name="title" content="Customization | BlazerTech Character Management System ">
7+
<meta name="title" content="Basic Concepts | BlazerTech Character Management System ">
88

99

1010
<link rel="icon" href="../../favicon.ico">
@@ -85,8 +85,45 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8585
</div>
8686

8787
<article data-uid="basic-concepts">
88-
89-
<h2 id="basic-concepts">Basic Concepts</h2>
88+
<h1 id="basic-concepts">Basic Concepts</h1>
89+
90+
<h2 id="character-types">Character Types</h2>
91+
<p><a class="xref" href="../character-types.html">Read More → Character Types</a></p>
92+
<p>A character type define how the character works. There are two types of character types:</p>
93+
<h3 id="1-unified-character-type">1. Unified Character Type</h3>
94+
<p>Each character uses a single spritesheet containing the fully assembled character. No runtime customization is possible.</p>
95+
<ul>
96+
<li><strong>Use Case:</strong> Characters with fixed, pre-set appearances.</li>
97+
<li><strong>Example:</strong> Simplistic characters where their appearance is pre-determined and won't need to be changed.</li>
98+
</ul>
99+
<p><a href="unified-character-type.md">Read More → Unified Character Type</a></p>
100+
<hr>
101+
<h3 id="2-layered-character-type">2. Layered Character Type</h3>
102+
<p>A set of separate spritesheets, each containing one visual layer of the character.</p>
103+
<ul>
104+
<li><strong>Use Case:</strong> Customizable player characters or dynamically generated NPCs.</li>
105+
<li><strong>Example:</strong> Body, Outfit, Hairstyle, Accessory</li>
106+
</ul>
107+
<p><a href="layered-character-type.md">Read More → Layered Character Type</a></p>
108+
<hr>
109+
<h2 id="character-creator">Character Creator</h2>
110+
<p>A fully modular Character Creation Menu System for layered characters. Easily implement your own Character Creation Menu by adding pre-made scripts and prefabs.</p>
111+
<h3 id="use-case-examples">Use-case Examples</h3>
112+
<h4 id="1-customizable-player-character">1. Customizable Player Character</h4>
113+
<p>The Character Creation Menu can be easily setup for a single character such as the player character. Once made it can easily be used anywhere in-game.</p>
114+
<h4 id="2-customizing-a-list-of-characters">2. Customizing a List of Characters</h4>
115+
<p>Pre-created lists of charactes can be edited one by one.
116+
Or a dynamic list can be used and allow the player to create, edit and delete characters at any time.</p>
117+
<hr>
118+
<h3 id="customizability">Customizability:</h3>
119+
<ul>
120+
<li><strong>Character Piece Selectors</strong> - Dropdowns, Carousel Selectors, Tabs, etc.</li>
121+
<li><strong>Character Preview</strong> - Static, Animated, Change Animations, Rotate Character.</li>
122+
<li><strong>History</strong> - all changes are recorded and can be shown as text or image snapshots. Clicking an entry will revert to that snapshot.</li>
123+
<li><strong>Character Randomization</strong> - Randomize the entire character or specific layers.</li>
124+
<li><strong>Character Name Field</strong> - Optional.</li>
125+
</ul>
126+
<p><a class="xref" href="../Essentials/character-creator.html">Read More → Character Creator</a></p>
90127

91128
</article>
92129

0 commit comments

Comments
 (0)