From 52f794419bb61ede04d31cee6c854da868cc8b4e Mon Sep 17 00:00:00 2001 From: Starystars67 Date: Sat, 4 Nov 2023 22:39:06 +0000 Subject: [PATCH] Added new pages + new nav and file structure to be compatible with multi language --- Removed Pages/xindex.md | 53 +++++++++++++++++++ docs/en/beamng/dev/content/maps.md | 19 +++++++ docs/en/beamng/dev/content/props.md | 19 +++++++ docs/en/beamng/dev/content/vehicles.md | 19 +++++++ docs/en/beamng/dev/index.md | 9 ++++ .../dev}/modding/imgui-windows.md | 0 .../dev}/modding/lua-mods.md | 0 .../{guides => beamng/dev}/modding/ui-apps.md | 0 docs/en/beamng/index.md | 7 ++- docs/en/beamng/snippets.md | 8 +++ docs/en/contributing.md | 2 +- docs/en/game/tailoring.md | 9 ++++ docs/en/guides/index.md | 13 ++++- .../mod-creation/client/getting-started.md | 10 ++++ .../mod-creation/server/getting-started.md | 10 ++++ docs/en/guides/resource-development.md | 1 - docs/en/guides/resources/getting-started.md | 0 docs/en/scripting/mod-reference.md | 9 ++++ docs/en/scripting/mod/index.md | 0 .../{server/index.md => server-reference.md} | 8 +++ docs/en/support/index.md | 5 -- mkdocs.yml | 37 ++++++++----- 22 files changed, 217 insertions(+), 21 deletions(-) create mode 100644 Removed Pages/xindex.md create mode 100644 docs/en/beamng/dev/content/maps.md create mode 100644 docs/en/beamng/dev/content/props.md create mode 100644 docs/en/beamng/dev/content/vehicles.md create mode 100644 docs/en/beamng/dev/index.md rename docs/en/{guides => beamng/dev}/modding/imgui-windows.md (100%) rename docs/en/{guides => beamng/dev}/modding/lua-mods.md (100%) rename docs/en/{guides => beamng/dev}/modding/ui-apps.md (100%) create mode 100644 docs/en/game/tailoring.md create mode 100644 docs/en/guides/mod-creation/client/getting-started.md create mode 100644 docs/en/guides/mod-creation/server/getting-started.md delete mode 100644 docs/en/guides/resource-development.md delete mode 100644 docs/en/guides/resources/getting-started.md create mode 100644 docs/en/scripting/mod-reference.md delete mode 100644 docs/en/scripting/mod/index.md rename docs/en/scripting/{server/index.md => server-reference.md} (99%) delete mode 100644 docs/en/support/index.md diff --git a/Removed Pages/xindex.md b/Removed Pages/xindex.md new file mode 100644 index 00000000..e83509cc --- /dev/null +++ b/Removed Pages/xindex.md @@ -0,0 +1,53 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# BeamMP Documentation + +Welcome to the BeamMP Project Documentation site! Here you will find detailed information about our multiplayer mod, designed to enhance your gaming experience with exciting multiplayer features. Whether you're a developer, a gamer, or both, this documentation will guide you through the installation, usage, and customization of our mod. + +## Language Versions + +- **English:** [Here](/en) +- **Español:** [Aquí](/es) +- **Français:** [Ici](/fr) +- **Italiano** [Qui](/it) +- **Deutsch:** [Hier](/de) +- **Pусский** [Здесь](/ru) + +## What is BeamMP? + +BeamMP is a community-driven project aimed at bringing multiplayer functionality to BeamNG.drive. With this mod, players can connect, interact, and communicate shared gaming environment, adding a sense of community and enhancing the overall gameplay experience. You can further build on this by creating custom resources for your servers too. + +## Features + +- **Cross-Platform Compatibility:** Our mod supports multiple platforms, allowing players on different devices to join the same multiplayer sessions seamlessly. +- **Real-Time Communication:** Chat with other players, strategize, and coordinate your actions in real-time during gameplay. +- **Customizable Gameplay:** Tailor the multiplayer experience to your liking with full scripting interface both client and serverside. +- **Modding Support:** Extend the mod's functionality and create your own unique multiplayer experiences with modding support. + +## Getting Started + +Select your language of choice above to get started! + +## Contributing + +We welcome contributions from the community! If you're interested in helping us improve the mod, documentation or another aspect please check out our [GitHub](https://github.com/beammp) and the respective repositories. Alternatively if you only want to help with the docs then the page and pencil icon in the top right of each page will allow you to edit them and commit your changes for review. + +## Community + +Join our community to connect with other players, share your experiences, ask questions, and stay updated with the latest developments and updates. + +- **Forum:** Visit our [Community Forum](https://forum.beammp.com) to participate in discussions and share your ideas. +- **Discord:** Join our [Discord Server](https://discord.gg/beammp) for real-time chat with fellow players and developers. +- **GitHub:** Follow us on [GitHub](https://github.com/beammp) for updates on our work. + +## Support + +If you encounter any issues or have questions, please contact us on our forum or our discord server for assistance. Our dedicated support team is here to help you. + +Thank you for being a part of our community! diff --git a/docs/en/beamng/dev/content/maps.md b/docs/en/beamng/dev/content/maps.md new file mode 100644 index 00000000..2a0e00aa --- /dev/null +++ b/docs/en/beamng/dev/content/maps.md @@ -0,0 +1,19 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# BeamNG.drive Map Creation + +... + +## Introduction + +... + +## Getting Started + +... \ No newline at end of file diff --git a/docs/en/beamng/dev/content/props.md b/docs/en/beamng/dev/content/props.md new file mode 100644 index 00000000..3eddc91a --- /dev/null +++ b/docs/en/beamng/dev/content/props.md @@ -0,0 +1,19 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# BeamNG.drive Prop Creation + +... + +## Introduction + +... + +## Getting Started + +... \ No newline at end of file diff --git a/docs/en/beamng/dev/content/vehicles.md b/docs/en/beamng/dev/content/vehicles.md new file mode 100644 index 00000000..f8a9a749 --- /dev/null +++ b/docs/en/beamng/dev/content/vehicles.md @@ -0,0 +1,19 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# BeamNG.drive Vehicle Creation + +... + +## Introduction + +... + +## Getting Started + +... \ No newline at end of file diff --git a/docs/en/beamng/dev/index.md b/docs/en/beamng/dev/index.md new file mode 100644 index 00000000..bef3fd12 --- /dev/null +++ b/docs/en/beamng/dev/index.md @@ -0,0 +1,9 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# BeamNG.drive Development Introduction \ No newline at end of file diff --git a/docs/en/guides/modding/imgui-windows.md b/docs/en/beamng/dev/modding/imgui-windows.md similarity index 100% rename from docs/en/guides/modding/imgui-windows.md rename to docs/en/beamng/dev/modding/imgui-windows.md diff --git a/docs/en/guides/modding/lua-mods.md b/docs/en/beamng/dev/modding/lua-mods.md similarity index 100% rename from docs/en/guides/modding/lua-mods.md rename to docs/en/beamng/dev/modding/lua-mods.md diff --git a/docs/en/guides/modding/ui-apps.md b/docs/en/beamng/dev/modding/ui-apps.md similarity index 100% rename from docs/en/guides/modding/ui-apps.md rename to docs/en/beamng/dev/modding/ui-apps.md diff --git a/docs/en/beamng/index.md b/docs/en/beamng/index.md index 5bdbb90b..ac544901 100644 --- a/docs/en/beamng/index.md +++ b/docs/en/beamng/index.md @@ -1,4 +1,9 @@ -# Welcome to the BeamNG.drive documentation by BeamMP/The Community +# Welcome to the BeamNG.drive documentation +This documentation is unofficial and produced by the BeamMP Mod Team and the BeamNG Community. + +## Understanding The File Structure +... + ## Snippets diff --git a/docs/en/beamng/snippets.md b/docs/en/beamng/snippets.md index 46acc315..634f81bb 100644 --- a/docs/en/beamng/snippets.md +++ b/docs/en/beamng/snippets.md @@ -1,3 +1,11 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + # BeamNG.drive Snippets ## Lua Code Snippets diff --git a/docs/en/contributing.md b/docs/en/contributing.md index b9f63471..58bf5447 100644 --- a/docs/en/contributing.md +++ b/docs/en/contributing.md @@ -1,7 +1,7 @@ # Contributing to the BeamMP Docs BeamMP is using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material) as its theme. This is a theme for [MkDocs](https://www.mkdocs.org). -Full documentation can be found at their respective sites.cs.org). +Full documentation can be found at their respective sites. ## Getting Started diff --git a/docs/en/game/tailoring.md b/docs/en/game/tailoring.md new file mode 100644 index 00000000..2cd7a229 --- /dev/null +++ b/docs/en/game/tailoring.md @@ -0,0 +1,9 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# Customizing your BeamMP Installation \ No newline at end of file diff --git a/docs/en/guides/index.md b/docs/en/guides/index.md index f2984faa..693bbbb0 100644 --- a/docs/en/guides/index.md +++ b/docs/en/guides/index.md @@ -3,5 +3,16 @@ title: Guides description: This set of pages provides some basic guides for BeamMP status: new --- +!!! warning "This site is under construction!" -# Guides \ No newline at end of file + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# BeamMP Development Guides + +This page will be the introduction and preface for both client and server content creation. + +This page needs developing still. \ No newline at end of file diff --git a/docs/en/guides/mod-creation/client/getting-started.md b/docs/en/guides/mod-creation/client/getting-started.md new file mode 100644 index 00000000..14e0ebf6 --- /dev/null +++ b/docs/en/guides/mod-creation/client/getting-started.md @@ -0,0 +1,10 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# Getting started +This page is going to take you through creating BeamMP mods for the game client. \ No newline at end of file diff --git a/docs/en/guides/mod-creation/server/getting-started.md b/docs/en/guides/mod-creation/server/getting-started.md new file mode 100644 index 00000000..258ab627 --- /dev/null +++ b/docs/en/guides/mod-creation/server/getting-started.md @@ -0,0 +1,10 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# Getting started +This page is going to take you through creating BeamMP resources for the server. \ No newline at end of file diff --git a/docs/en/guides/resource-development.md b/docs/en/guides/resource-development.md deleted file mode 100644 index 74727bef..00000000 --- a/docs/en/guides/resource-development.md +++ /dev/null @@ -1 +0,0 @@ -# Server Resource Development Guide \ No newline at end of file diff --git a/docs/en/guides/resources/getting-started.md b/docs/en/guides/resources/getting-started.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/en/scripting/mod-reference.md b/docs/en/scripting/mod-reference.md new file mode 100644 index 00000000..2ba9a90e --- /dev/null +++ b/docs/en/scripting/mod-reference.md @@ -0,0 +1,9 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + +# Mod/In-Game Scripting Reference diff --git a/docs/en/scripting/mod/index.md b/docs/en/scripting/mod/index.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/en/scripting/server/index.md b/docs/en/scripting/server-reference.md similarity index 99% rename from docs/en/scripting/server/index.md rename to docs/en/scripting/server-reference.md index 2e058bb4..f733858e 100644 --- a/docs/en/scripting/server/index.md +++ b/docs/en/scripting/server-reference.md @@ -1,3 +1,11 @@ +!!! warning "This site is under construction!" + + This site is being actively worked on. + + Feel you could help? Please do by clicking on the page with a pencil on the right! + + This can be done any page too. + # Server Scripting Reference ## Server Version 3.X diff --git a/docs/en/support/index.md b/docs/en/support/index.md deleted file mode 100644 index 9885f840..00000000 --- a/docs/en/support/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Support - -!!! warning "This page is under construction!" - - This page still needs to be created. Feel you could help? Please do! diff --git a/mkdocs.yml b/mkdocs.yml index 2cf56b17..defcaaa7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,8 +21,6 @@ theme: - content.code.copy - content.action.edit - content.action.view - - navigation.instant - - navigation.instant.progress - navigation.footer - navigation.tabs - navigation.sections @@ -136,6 +134,7 @@ plugins: Snippets: Fragmentos de Código BeamNG Documentation: Documentación de BeamNG Installation: Instalación + Helpful Snippets: Fragmentos Útiles Scripting Reference: Referencia de Scripting Mod (In-Game): Mod (En el Juego) Server: Servidor @@ -170,6 +169,7 @@ plugins: Snippets: Code-Schnipsel BeamNG Documentation: BeamNG-Dokumentation Installation: Installation + Helpful Snippets: Nützliche Codeausschnitte Scripting Reference: Scripting-Referenz Mod (In-Game): Mod (Im Spiel) Server: Server @@ -204,6 +204,7 @@ plugins: Snippets: Extraits de code BeamNG Documentation: Documentation BeamNG Installation: Installation + Helpful Snippets: Extraits Utiles Scripting Reference: Référence de script Mod (In-Game): Mod (En jeu) Server: Serveur @@ -238,6 +239,7 @@ plugins: Snippets: Frammenti di Codice BeamNG Documentation: Documentazione BeamNG Installation: Installazione + Helpful Snippets: Snippet Utili Scripting Reference: Riferimento allo Scripting Mod (In-Game): Mod (In gioco) Server: Server @@ -272,6 +274,7 @@ plugins: Snippets: Фрагменты кода BeamNG Documentation: Документация BeamNG Installation: Установка + Helpful Snippets: Полезные фрагменты Scripting Reference: Справочник по скриптингу Mod (In-Game): Мод (в игре) Server: Сервер @@ -308,24 +311,34 @@ nav: - Server Installation: server/create-a-server.md - Server Manual: server/manual.md - Mod & Resource Creation: - - Client Side: guides/resources/getting-started.md - - Server Side: guides/resources/getting-started.md + - Client Side: guides/mod-creation/client/getting-started.md + - Server Side: guides/mod-creation/server/getting-started.md - Support: - Game FAQ: support/game-faq.md - Server FAQ: support/server-faq.md - Development Guides: - guides/index.md - Mod Creation: - - UI Apps: guides/modding/ui-apps.md - - IMGUI Windows: guides/modding/imgui-windows.md - - Lua Mods: guides/modding/lua-mods.md + - Client Mods: guides/mod-creation/client/getting-started.md + - Client Scripting Reference: scripting/mod-reference.md - Resource Creation: - - UI Apps: guides/resources/getting-started.md - - Snippets: guides/resources/snippets.md + - Server Resources: guides/mod-creation/server/getting-started.md + - Server Scripting Reference: scripting/server-reference.md - BeamNG Documentation: - - Installation: beamng/index.md + - beamng/index.md + - Content Development: + - Introduction: beamng/dev/index.md + - Coding: + - UI Apps (HTML): beamng/dev/modding/ui-apps.md + - IMGUI Windows (Lua): beamng/dev/modding/imgui-windows.md + - Lua Mods (Scripts): beamng/dev/modding/lua-mods.md + - Content: + - Maps: beamng/dev/content/maps.md + - Props: beamng/dev/content/props.md + - Vehicles: beamng/dev/content/vehicles.md + - Helpful Code Snippets: beamng/snippets.md - Scripting Reference: - - Mod (In-Game): scripting/mod/index.md - - Server: scripting/server/index.md + - Mod (In-Game): scripting/mod-reference.md + - Server: scripting/server-reference.md - Contributing: - Getting Started: contributing.md \ No newline at end of file