Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH42 Multilingual documentation functionality has been created, English + Russian #91

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
345 changes: 200 additions & 145 deletions mirror-docs/docusaurus.config.js

Large diffs are not rendered by default.

357 changes: 357 additions & 0 deletions mirror-docs/i18n/ru/code.json

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions mirror-docs/i18n/ru/docusaurus-plugin-content-blog/options.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"title": {
"message": "Blog",
"description": "The title for the blog used in SEO"
},
"description": {
"message": "Blog",
"description": "The description for the blog used in SEO"
},
"sidebar.title": {
"message": "Recent posts",
"description": "The label for the left sidebar"
}
}
70 changes: 70 additions & 0 deletions mirror-docs/i18n/ru/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"version.label": {
"message": "Next",
"description": "The label for version current"
},
"sidebar.tutorialSidebar.category.Build": {
"message": "Build",
"description": "The label for category Build in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Build.link.generated-index.description": {
"message": "There are 2 main modes in The Mirror: Build and Play. Build Mode has the power of a full-blown game engine for whatever you can imagine, developed in real-time with your fellow builders.",
"description": "The generated-index page description for category Build in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Scripting": {
"message": "Scripting",
"description": "The label for category Scripting in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Scripting.link.generated-index.description": {
"message": "Bring your games to life with The Mirror's high-level visual scripting. Coding can be daunting, which is why The Mirror provides no-code visual scripting out-of-the-box to make it easy for people of any skill level to build in The Mirror. Visual scripting is still programming, but high-level, and without needing to write code as text. Full support for GDScript is also available if you prefer writing text-based code.",
"description": "The generated-index page description for category Scripting in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Physics": {
"message": "Physics",
"description": "The label for category Physics in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Physics.link.generated-index.description": {
"message": "The Mirror includes Jolt physics, an advanced physics engine. Everything is exposed with a high-level API and is networked out of the box.",
"description": "The generated-index page description for category Physics in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Play": {
"message": "Play",
"description": "The label for category Play in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Play.link.generated-index.description": {
"message": "There are 2 main modes in The Mirror: Build and Play. Play Mode is where your published games take flight and can be played by anyone in the world.",
"description": "The generated-index page description for category Play in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Users": {
"message": "Users",
"description": "The label for category Users in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Users.link.generated-index.description": {
"message": "Showcase your Mirror Image and interact with other people in The Mirror.",
"description": "The generated-index page description for category Users in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Monetize": {
"message": "Monetize",
"description": "The label for category Monetize in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Monetize.link.generated-index.description": {
"message": "Easily monetize your game with in-Space transactions, buy/sell assets, perks, power-ups, levels, quests, items, skins, and much more",
"description": "The generated-index page description for category Monetize in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.REST API": {
"message": "REST API",
"description": "The label for category REST API in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.REST API.link.generated-index.description": {
"message": "The Mirror exposes a REST API to query Spaces, Objects, Assets, and more.",
"description": "The generated-index page description for category REST API in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Open-Source Code": {
"message": "Open-Source Code",
"description": "The label for category Open-Source Code in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Open-Source Code.link.generated-index.description": {
"message": "Documentation for The Mirror's open-source monorepo: https://github.com/the-mirror-gdp/the-mirror",
"description": "The generated-index page description for category Open-Source Code in sidebar tutorialSidebar"
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Assets",
"position": 3,
"link": {
"type": "generated-index",
"description": "Assets are key building blocks of The Mirror, such as a mesh, image/texture, material, audio, and more. Assets can be imported and instanced as Objects and programmed via scripts."
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
sidebar_position: 1.81
---

import Tabs from '@theme/Tabs';
import Table from '/src/components/Table';

import TabItem from '@theme/TabItem';
import YouTube from 'react-youtube';

# 3D Models & Equipables

## 3D Models

- **Formats**: GLB and GLTF with more types planned for the future.

- **File Size**: The maximum allowed file size for 3D models is 15MB per file. This limitation is due to automatic compression isn't available at the moment. This limitation will increase in the future.

- **Texture Size**: This is platform dependent:

- Mid-range+ GPU: maximum size of 2k (2048x2048 pixels).
- VR or Low-range GPU (such as mobile): maximum size of 1k (1024x1024 pixels).

:::note
We recommend adhering to the power of two rule when creating textures. You can learn more [here](https://www.katsbits.com/tutorials/textures/make-better-textures-correct-size-and-power-of-two.php#:~:text=What%20is%20the%20power%20of,%2Ddown%20by%20%222%22.)
:::

- **Trim Sheets**: For large objects such as buildings, it is recommended to use trim sheets. Trim sheets optimize texture usage and improve performance.

- **Style**: While The Mirror itself adheres to a semi-realistic style, there are no limits on what style you can achieve in The Mirror. You have complete freedom in choosing whichever style, The Mirror will support it.

- **Vertex Count**: For optimial performance it is recommended models are below 30K vertices.

:::note
Budgeting your polygon or vertex count is generally tricky; it depends on the platform the game is running on, where the model is in the scene compared to the camera, how many of said model is in the scene, etc... For example, a sword model in an FPS game may have the same vertex count as a house in the far distance of a map that the player will never reach or get close to.
:::

- **GPU Compatibility**: The Mirror supports mid-range GPUs that are compatible with Vulkan or higher graphics APIs. For example, an Nvidia GTX 1650 should be capable of running the game at 1080p resolution with a stable 60 FPS.

- **Custom Shaders**: Currently, custom shaders are not supported. Please utilize the default shaders provided by the game. We plan to allow for this in the future.

## Equipables

Info coming soon.
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
sidebar_position: 0.1
---

import Tabs from '@theme/Tabs';
import Table from '/src/components/Table';

import TabItem from '@theme/TabItem';

Characters come out-of-the-box in The Mirror, saving you time from building your own player controller. If you're coming from a traditional game engine background, you may be accustomed to building your own player (character) object from scratch.

The Mirror is different from game engines. Similar to Garry's Mod, The Mirror gives you a player controller out-of-the-box. When you begin, you have control of a physical character in the world with smooth controls. This is a fully functional player object that you can use to navigate the game world.

In the future, you'll be able to completely replace this physical character with custom player controllers of your choosing, such as camera adjustments for a top-down strategy game.

# Controlling Your Character

By default, your spawned character follows default FPS (First Person Shooter) and TPS (Third Person Shooter) controls:

![](2023-02-23-19-02-20.jpg)

<Table
headers={[`Input`, `Action`]}
data={[
[`W`, `Move Forward`],
[`S`, `Move Backward`],
[`A`, `Move Left`],
[`D`, `Move Right`],
[`Shift`, `Run`],
[`Space`, `Jump`],
[`E`, `Interact`],
[`C`, `Toggle First Person/Third Person Camera`],
]}
/>

# Changing Your Character

You can change the character model and even import your own into The Mirror.

- Press `Escape` to open the main menu.

![MainMenu](./mainmenu.png)

- On the top right, click the "Avatar" tab.

![AvatarTab](./avatartab.png)

- Currently, The Mirror has two default avatars as seen above. However, you are able to import your own avatar by clicking on the "Import Avatar" button and following the step by step instructions on screen. Alternatively, you can follow the guide [here](/docs/users/ready-player-me)

- Once you've chosen your avatar or imported your own, you'll need to reconnect to your Space for the change to take effect.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Build",
"position": 2,
"link": {
"type": "generated-index",
"description": "There are 2 main modes in The Mirror: Build and Play. Build Mode has the power of a full-blown game engine for whatever you can imagine, developed in real-time with your fellow builders."
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 1.82
---

import Tabs from '@theme/Tabs';
import Table from '/src/components/Table';

import TabItem from '@theme/TabItem';
import YouTube from 'react-youtube';

# Audio

- **Format**: We currently support .WAV and .MP3 file extension. Support for .OGG is coming soon.
- **File Size**: The maximum allowed file size for audio files is 15MB per file. This limitation will increase in the future.
Loading