Added new pages + new nav and file structure to be compatible with multi language

This commit is contained in:
Starystars67 2023-11-04 22:39:06 +00:00
parent 78bce849ab
commit 52f794419b
22 changed files with 217 additions and 21 deletions

53
Removed Pages/xindex.md Normal file
View File

@ -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!

View File

@ -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
...

View File

@ -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
...

View File

@ -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
...

View File

@ -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

View File

@ -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 ## Snippets

View File

@ -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 # BeamNG.drive Snippets
## Lua Code Snippets ## Lua Code Snippets

View File

@ -1,7 +1,7 @@
# Contributing to the BeamMP Docs # 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). 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 ## Getting Started

View File

@ -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

View File

@ -3,5 +3,16 @@ title: Guides
description: This set of pages provides some basic guides for BeamMP description: This set of pages provides some basic guides for BeamMP
status: new status: new
--- ---
!!! warning "This site is under construction!"
# Guides 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.

View File

@ -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.

View File

@ -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.

View File

@ -1 +0,0 @@
# Server Resource Development Guide

View File

@ -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

View File

@ -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 Scripting Reference
## Server Version 3.X ## Server Version 3.X

View File

@ -1,5 +0,0 @@
# Support
!!! warning "This page is under construction!"
This page still needs to be created. Feel you could help? Please do!

View File

@ -21,8 +21,6 @@ theme:
- content.code.copy - content.code.copy
- content.action.edit - content.action.edit
- content.action.view - content.action.view
- navigation.instant
- navigation.instant.progress
- navigation.footer - navigation.footer
- navigation.tabs - navigation.tabs
- navigation.sections - navigation.sections
@ -136,6 +134,7 @@ plugins:
Snippets: Fragmentos de Código Snippets: Fragmentos de Código
BeamNG Documentation: Documentación de BeamNG BeamNG Documentation: Documentación de BeamNG
Installation: Instalación Installation: Instalación
Helpful Snippets: Fragmentos Útiles
Scripting Reference: Referencia de Scripting Scripting Reference: Referencia de Scripting
Mod (In-Game): Mod (En el Juego) Mod (In-Game): Mod (En el Juego)
Server: Servidor Server: Servidor
@ -170,6 +169,7 @@ plugins:
Snippets: Code-Schnipsel Snippets: Code-Schnipsel
BeamNG Documentation: BeamNG-Dokumentation BeamNG Documentation: BeamNG-Dokumentation
Installation: Installation Installation: Installation
Helpful Snippets: Nützliche Codeausschnitte
Scripting Reference: Scripting-Referenz Scripting Reference: Scripting-Referenz
Mod (In-Game): Mod (Im Spiel) Mod (In-Game): Mod (Im Spiel)
Server: Server Server: Server
@ -204,6 +204,7 @@ plugins:
Snippets: Extraits de code Snippets: Extraits de code
BeamNG Documentation: Documentation BeamNG BeamNG Documentation: Documentation BeamNG
Installation: Installation Installation: Installation
Helpful Snippets: Extraits Utiles
Scripting Reference: Référence de script Scripting Reference: Référence de script
Mod (In-Game): Mod (En jeu) Mod (In-Game): Mod (En jeu)
Server: Serveur Server: Serveur
@ -238,6 +239,7 @@ plugins:
Snippets: Frammenti di Codice Snippets: Frammenti di Codice
BeamNG Documentation: Documentazione BeamNG BeamNG Documentation: Documentazione BeamNG
Installation: Installazione Installation: Installazione
Helpful Snippets: Snippet Utili
Scripting Reference: Riferimento allo Scripting Scripting Reference: Riferimento allo Scripting
Mod (In-Game): Mod (In gioco) Mod (In-Game): Mod (In gioco)
Server: Server Server: Server
@ -272,6 +274,7 @@ plugins:
Snippets: Фрагменты кода Snippets: Фрагменты кода
BeamNG Documentation: Документация BeamNG BeamNG Documentation: Документация BeamNG
Installation: Установка Installation: Установка
Helpful Snippets: Полезные фрагменты
Scripting Reference: Справочник по скриптингу Scripting Reference: Справочник по скриптингу
Mod (In-Game): Мод (в игре) Mod (In-Game): Мод (в игре)
Server: Сервер Server: Сервер
@ -308,24 +311,34 @@ nav:
- Server Installation: server/create-a-server.md - Server Installation: server/create-a-server.md
- Server Manual: server/manual.md - Server Manual: server/manual.md
- Mod & Resource Creation: - Mod & Resource Creation:
- Client Side: guides/resources/getting-started.md - Client Side: guides/mod-creation/client/getting-started.md
- Server Side: guides/resources/getting-started.md - Server Side: guides/mod-creation/server/getting-started.md
- Support: - Support:
- Game FAQ: support/game-faq.md - Game FAQ: support/game-faq.md
- Server FAQ: support/server-faq.md - Server FAQ: support/server-faq.md
- Development Guides: - Development Guides:
- guides/index.md - guides/index.md
- Mod Creation: - Mod Creation:
- UI Apps: guides/modding/ui-apps.md - Client Mods: guides/mod-creation/client/getting-started.md
- IMGUI Windows: guides/modding/imgui-windows.md - Client Scripting Reference: scripting/mod-reference.md
- Lua Mods: guides/modding/lua-mods.md
- Resource Creation: - Resource Creation:
- UI Apps: guides/resources/getting-started.md - Server Resources: guides/mod-creation/server/getting-started.md
- Snippets: guides/resources/snippets.md - Server Scripting Reference: scripting/server-reference.md
- BeamNG Documentation: - 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: - Scripting Reference:
- Mod (In-Game): scripting/mod/index.md - Mod (In-Game): scripting/mod-reference.md
- Server: scripting/server/index.md - Server: scripting/server-reference.md
- Contributing: - Contributing:
- Getting Started: contributing.md - Getting Started: contributing.md