Skip to content

Commit

Permalink
Merge pull request Gothic-Modding-Community#85 from kamilkrzyskow/awe…
Browse files Browse the repository at this point in the history
…some-pages-plugin

Awesome pages plugin
  • Loading branch information
auronen authored Apr 2, 2023
2 parents 6af7e93 + 0f4b5f9 commit 16ef42a
Show file tree
Hide file tree
Showing 52 changed files with 196 additions and 172 deletions.
6 changes: 6 additions & 0 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
nav:
- Home:
- ... | index*.md
- zengin
- genome
- contribute
3 changes: 3 additions & 0 deletions docs/contribute/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nav:
- ... | index*.md
- ...
2 changes: 1 addition & 1 deletion docs/contribute/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# How to contribute

[gmc-discord]: https://discord.gg/mCpS5b5SUY
[git-download]: https://git-scm.com/downloads
[python-download]: https://www.python.org/downloads/

# How to contribute
The Gothic Modding Community is a community-driven project. We encourage people to contribute.

This site is built with a Static Site Generator [MkDocs](https://www.mkdocs.org/) and the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme together with multiple other MkDocs plugins.
Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/index.pl.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Jak się udzielić

[gmc-discord]: https://discord.gg/mCpS5b5SUY
[git-download]: https://git-scm.com/downloads
[python-download]: https://www.python.org/downloads/

# Jak się udzielić
Gothic Modding Community jest projektem napędzanym przed społeczność. Zachęcamy osoby do wnoszenia swojego wkładu.

Ta strona jest budowana przy pomocy statycznego generatora stron [MkDocs](https://www.mkdocs.org/) oraz skórki [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), wraz z wieloma innymi wtyczkami do MkDocs.
Expand Down
4 changes: 4 additions & 0 deletions docs/genome/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
nav:
- ... | index*.md
- general_info
- ...
6 changes: 6 additions & 0 deletions docs/zengin/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
nav:
- ... | index*.md
- general_info
- ...
- tools
- union
3 changes: 3 additions & 0 deletions docs/zengin/anims/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nav:
- ...
- tutorials
3 changes: 3 additions & 0 deletions docs/zengin/anims/events.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: EventBlocks
---
## Animation event blocks
We often need to perform some other actions together with our animation, such as playing a sound effect, inserting item into NPC's hand or changing an item instance into a different one, like turning a raw steel into hot raw steel.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/anims/mds.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: MDS ModelScript
---

# MDS - model animation script

Expand Down
3 changes: 2 additions & 1 deletion docs/zengin/anims/tutorials/standalone_animation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Standalone animation
!!! example "Acknowledgment"
This tutorial would not be possible without the ZenGin documentation available in the mod-kit. Further credits also go to [Mark56](https://carnage-markus.blogspot.com) who helped me understand animations in the first place, [Fawkes](https://www.youtube.com/channel/UCheR2tr8u1CsUGG15Lu2mxQ) and his request for me to do some animations for his excellent mod - Replay Mod, and last but not least Flosha from the Phoenix team who was the one for whom I offered to write this tutorial to help with the development of the [Phoenix project](https://phoenixthegame.com/).
# Standalone animation

Let us start with the easiest animation - a very simple gesturing animation.

!!! info
Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/general_info/directory_structure.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Directory structure
---
# ZenGin directory structure

Modding is all about changing the game files. To achieve that, we have to know the directory (folder) structure of a Gothic game.
Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/general_info/vdfs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: VDFS virtual file system
---
# VDFS

VDFS is the virtual file system used by ZenGin to distribute and store many, but not all, game assets.
Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nav:
- classes
- ...
3 changes: 3 additions & 0 deletions docs/zengin/scripts/classes/c_info.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: C_INFO
---
# C_INFO Daedalus class

!!! example "Acknowledgment"
Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/classes/c_item.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: C_ITEM
---
# C_ITEM Daedalus class

!!! example "Acknowledgment"
Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/classes/c_svm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: C_SVM
---
# C_SVM Daedalus class

!!! example "Acknowledgment"
Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/afsp/afsp_eim.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Enhanced Info Manager
---
# Enhanced Information Manager

!!! Warning
Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/ikarus/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nav:
- ...
- ... | examples*.md
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/ikarus/examples.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Examples
---
# Ikarus examples
A collection of examples ported from the original Ikarus documentation.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/ikarus/functions/ini_access.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Ini File Access
---
# Configuration file access
This part of Ikarus gives you access to `Gothic.ini` and loaded mod configuration files.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/ikarus/functions/keyboard.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Keyboard
---
# Keyboard interaction
This part of Ikarus implements function that make interaction with keyboard possible.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/ikarus/functions/mem_access.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Memory Access
---
# Elementary memory access
This part of Ikarus makes it possible to read and write memory as different data types - integers, strings, arrays of integers or strings and bytes.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/lego/applications/bars.pl.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Paski
---
# Bars - paski
Ten pakiet bardzo ułatwia dodawanie nowych pasków, dla wyświetlania np. wytrzymałości.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Polecenia konsoli
---
# Console Commands - polecenia konsoli
Ten Pakiet pozwala na tworzenie nowych poleceń konsoli dostępnej po naciśnięciu klawisza F2 w trybie marvin.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Stan gry
---
# Gamestate - stan gry
Pakiet Gamestate pozwala sprawdzić stan gry (rozpoczęcie gry, ładowanie gry lub zmiana poziomu).

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/lego/tools/ai_function.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: AI_Function
---
# AI Function
This package allows time-delayed functions to be called by enqueuing the functions in the AI queue of the NPC in question. This can be very useful e.g. cutscenes.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/lego/tools/item_helper.pl.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: ItemHelper
---
# ItemHelper - pomocnik do przedmiotów
Ten pakiet jest bardzo prosty - pobiera wskaźnik `oCItem` z instancji `C_ITEM` ważnej dla bieżącego świata i sesji.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/lego/tools/misc.pl.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Różne
---
# Misc - różne
Pakiet Misc wprowadza różne funkcje pomocnicze, które nie pasowały do żadnego innego pakietu.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/lego/tools/talents.pl.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Talenty
---
# Talents - talenty
Ten pakiet robi dwie rzeczy:

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/zparserextender/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nav:
- ...
- examples
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: C_Trigger class
---
# Trigger functions and the `C_Trigger` class
zParserExtender also implements cyclical functions called triggers - not to be confused with triggers in ZEN files, similar to a part of the functionality implemented in [LeGo AI_Functions](../../lego/tools/ai_function.md). These functions are called independently after a specified period of time. These triggers can also store user information. Up to 16 int variables can be stored in each trigger as well as `self`, `other` and `victim` instances.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Hooking
---
# Hooking Daedalus
Daedalus hooking is one of the most powerful features of this plugin. Hooking is a mechanism that allows you to replace any scripted object with a new one. To do this, you must define a new object with the same type, name and in the same [namespace](../syntax_extensions/namespaces.md).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Other features
---
# Other functions of the extender
## ini parameters
The choice of ini file depends on how the game was launched. If it was launched from Gothic.exe, then the parameters will be read from `SystemPack.ini`. If it was launched through GothicStarter.exe, then they will be read from the ini of the mod.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Sign post example
---
# Sign post teleportation
This is a short "problem-solving" example, where we try to demonstrate the power of Daedalus injection using [zParserExtender](../../index.md). GaroK asked me if there is a way to teleport to all the sign posts in Khorinis to gather information for a Gothic wiki article.
The goal is to introduce a function that will teleport you to every signpost in Khorinis with the press of a button.
Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/scripts/extenders/zparserextender/externals/ai.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: AI functions
---
# AI - functions for working with AI
Functions to work with the new [`C_Trigger`](../classes/c_trigger.md) class and NPC's AI queue.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: CAST functions
---
# CAST - data type conversion functions
External functions for data type conversion and pointer casting.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Event functions
---
# Event functions and variables
On top of external functions, zParserExtender also adds these event functions and constants.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: HLP functions
---
# HLP - help functions
Helper functions generally used for safety checks, to get specific information from the engine or to interface with the configuration `.ini` files.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: MDL functions
---
# MDL - model functions
Functions to tweak animation and other model related settings.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: MOB functions
---
# MOB - interactive object functions
Functions to manipulate interactive objects like destroying MOBs, setting lockpick combination and such.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: NPC functions
---
# NPC - character functions
NPC related functions.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: PAR functions
---
# PAR - functions for parser manipulation
Parser functions are used to manipulate the parsers. Retrieve SymbolID, access arrays and such.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: VOB functions
---
# VOB - functions for object manipulation
VOB functions allow you to manipulate game world objects.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: WLD functions
---
# WLD - world manipulation functions
Functions related to the world.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Test-else binding
---
# Test-else statements

The test-else bind statement can be used to define sections of code to be compiled. If the code is within the boundaries of the inactive test-else branch, it will not be compiled. This operator can take values as input that are converted to logical values. For example, if an object is passed as an argument, the parser will check for its existence. If it is an engine tag, it will return the result of matching the current engine with the tag:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: While loop
---
# Native WHILE loop
Just like [Ikarus](../../../../../notready.md) zParserExtender implements a while loop.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Pętla while
---
# Natywna pętla WHILE
Podobnie jak [Ikarus](../../../../../notready.md) zParserExtender implementuje pętlę while.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/union/plugins/zgamepad/controls.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Controls customization
---
# Gamepad controls
The zGamePad plugin comes with a default control scheme, but it is possible to create your own. The plugin will search for any file with the `.gamepad.overlay` extension placed in `Gothic/System` directory or in any of the loaded `.mod` and `.vdf` archives.

Expand Down
3 changes: 3 additions & 0 deletions docs/zengin/union/plugins/zgamepad/logical_functions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
title: Logical functions
---
# Logical function names
Conditions for when to show or allow the control binding to work are specified using these logic functions. They describe different useful states of the game or user interface, allowing the user to set when will a certain control work.
```
Expand Down
Loading

0 comments on commit 16ef42a

Please sign in to comment.