forked from ManticoreGamesInc/platform-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
230 lines (218 loc) · 8.47 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# Project information
site_name: Core Creator Hub
site_description: API Documentation & Tutorials for the Core Platform.
site_author: Manticore Games, Inc.
site_url: https://development.docs.coregames.com
# Repository
# repo_name: ManticoreGamesInc/platform-documentation
repo_url: https://github.com/ManticoreGamesInc/platform-documentation/
edit_uri: edit/development/src
# Copyright
copyright: "© 2020 Manticore Games, Inc. Core™ is a registered trademark of Manticore Games."
# Directory for the documentation pages
docs_dir: src
# If you add or remove a page, you must also add or remove in mkdocs-prod.yml
nav:
- News:
- News: https://forums.coregames.com/c/community/5
- Core:
- Core: https://www.coregames.com
- Documentation:
- Home: index.md
- Getting Started:
- Install Core: getting_started/installing_core.md
- Intro to the Editor: getting_started/editor_intro.md
- Create your first Game: getting_started/my_first_multiplayer_game.md
- Publish a Game: getting_started/publishing.md
- Getting Help in Core: getting_started/core_help.md
- D&D Contest RPG Framework:
- Overview: tutorials/rpg_framework_overview.md
- Create your first RPG game: tutorials/first_game_rpg.md
- D&D RPG Framework Reference: tutorials/rpg_framework_reference.md
- D&D RPG Framework Documentation: tutorials/rpg_framework_documentation.md
- Coming from other Platforms:
- Unity: other_platforms/unity.md
- Roblox: other_platforms/roblox.md
- World of Warcraft: other_platforms/world_of_warcraft.md
- Tutorials:
- Overview: tutorials/overview.md
- Abilities: tutorials/abilities.md
- Weapons: tutorials/weapons.md
- Weapons & Abilities (Advanced): tutorials/abilities_advanced.md
- Scripting: tutorials/lua_basics_lightbulb.md
- Scripting (Advanced): tutorials/lua_basics_manticoin.md
- Persistent Storage: tutorials/persistent_storage.md
- Scene Creation: tutorials/scene_creation.md
- Environment Art: tutorials/environment_art.md
- Modeling Basics: tutorials/modeling_basics.md
- Visual Effects in Core: tutorials/vfx_tutorial.md
- Video Tutorials:
- Making a Pistol Shooter: tutorials/videos/pistol_shooter.md
- GitHub and Core: tutorials/github.md
- Core Editor Manual:
- Scripting Introduction: tutorials/scripting_intro.md
- Editor Shortcuts: editor_keybindings.md
- Art in Core: tutorials/art_reference.md
- Modeling Reference: tutorials/modeling_reference.md
- Custom Materials: tutorials/custom_materials.md
- Object Generator: tutorials/object_generator.md
- Templates: tutorials/template_reference.md
- Community Content: getting_started/community_content.md
- Animated Meshes: tutorials/animated_mesh.md
- Audio: tutorials/audio_reference.md
- UI: tutorials/ui_reference.md
- Publishing Checklist: getting_started/publishing_checklist.md
- Performance Panel: getting_started/performance_panel.md
- Play-Mode Profiler: getting_started/profiler.md
- Core API:
- API Overview: core_api.md
- Game Components: api/components.md
- Ability Bindings: api/ability_bindings.md
- Animations & Sockets: api/animations.md
- Contexts: api/contexts.md
- Lua in Core: tutorials/lua_reference.md
- Lua Style Guide: tutorials/lua_style_guide.md
- Editor Extensions: extensions.md
- Examples & Snippets: api/examples.md
- Learn:
- Learn: https://learn.coregames.com
- Forums:
- Forums: https://forums.coregames.com
- Events:
- Events: https://forums.coregames.com/c/community/events/6
- Core Live:
- Core Live: https://forums.coregames.com/t/39
- Core API:
- API Overview: core_api.md
- Game Components: api/components.md
- Ability Bindings: api/ability_bindings.md
- Animations & Sockets: api/animations.md
- Contexts: api/contexts.md
- Lua in Core: tutorials/lua_reference.md
- Lua Style Guide: tutorials/lua_style_guide.md
- Editor Extensions: extensions.md
- Examples & Snippets: api/examples.md
- FAQ:
- Frequently Asked Questions: https://support.coregames.com/hc/en-us/categories/360003284214-FAQ
- Feedback:
- Feedback: https://support.coregames.com/hc/en-us/requests/new
# Theme configuration
theme:
name: null
custom_dir: mkdocs-material/material
language: en
font:
text: Lato
code: JetBrains Mono
features:
- tabs
- instant
palette:
primary: core-orange
accent: core-blue
logo: assets/icons/favicon-196x196.png
icon:
repo: fontawesome/brands/github
favicon: assets/favicon.ico
static_templates:
- 404.html
- offline.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
extra_css:
# - assets/stylesheets/manticore.css
extra_javascript:
- assets/javascripts/manticore.js
extra:
feedback_url: https://github.com/ManticoreGamesInc/platform-documentation/issues/new
social:
- icon: fontawesome/brands/discord
link: https://discord.gg/core-creators
name: Discord
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/CoreGamesOfficial
name: YouTube
- icon: fontawesome/brands/reddit
link: https://www.reddit.com/r/PlayCoreGames
name: Reddit
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/playcoregames
name: Facebook
- icon: fontawesome/brands/twitter
link: https://twitter.com/coregames
name: Twitter
- icon: fontawesome/brands/twitch
link: https://twitch.tv/corelive
name: Twitch
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.attr_list
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
slugify: !!python/name:custom_slugs.uslugify_custom
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
#- pymdownx.highlight:
#linenums_style: pymdownx-inline
- pymdownx.inlinehilite
- pymdownx.keys:
camel_case: true
- pymdownx.magiclink:
repo_url_shorthand: true
user: ManticoreGamesInc
repo: platform-documentation
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- full_yaml_metadata
- lightgallery
plugins:
- tags:
tags_folder: src/generated
- git-revision-date-localized
- search
- autolinks
- redirects:
redirect_maps:
getting_started.md: https://coregames.com/docs/getting_started/editor_intro/
news/showcase/just_getting_started.md: https://coregames.com/docs/showcase/just_getting_started/
api.md: https://docs.coregames.com/core_api/
tutorials/examples.md: https://docs.coregames.com/api/examples.md
tutorials/gameplay/abilities.md: tutorials/abilities.md
tutorials/gameplay/weapons.md: tutorials/weapons.md
tutorials/gameplay/abilities_advanced.md: tutorials/abilities_advanced.md
tutorials/gameplay/lua_basics_lightbulb.md: tutorials/lua_basics_lightbulb.md
tutorials/gameplay/lua_basics_manticoin.md: tutorials/lua_basics_manticoin.md
tutorials/gameplay/persistent_storage.md: tutorials/persistent_storage.md
tutorials/art/scene_creation.md: tutorials/scene_creation.md
tutorials/art/environmental_art.md: tutorials/environment_art.md
tutorials/art/modeling_basics.md: tutorials/modeling_basics.md
tutorials/gameplay/lua_reference.md: tutorials/lua_reference.md
tutorials/gameplay/lua_style_guide.md: tutorials/lua_style_guide.md
getting_started/other_engines.md: other_platforms/unity.md
getting_started/troubleshooting.md: getting_started/core_help.md
getting_started/other_platforms.md: other_platforms/unity.md
tutorials/environmental_art.md: tutorials/environment_art.md
tutorials/collaboration.md: tutorials/github.md
#google_analytics:
# - UA-142884846-4
# - auto