From 3b71c31783f040eb5da795283abdae31ffda0e48 Mon Sep 17 00:00:00 2001 From: Rail27 <205842434+Rail27@users.noreply.github.com> Date: Sun, 18 May 2025 08:43:29 +0900 Subject: [PATCH] Draft: Document Restrucuring --- README.md | 282 +----------------- docs/Knowledges/Beginner/Q&A/Common Issues.md | 23 ++ .../Q&A/How to install - Wallpape Engine.md | 48 +++ .../Knowledges/Beginner/Q&A/How to install.md | 70 +++++ .../Beginner/Q&A/How to use command.md} | 0 .../Beginner/Q&A/How to use this.md | 134 +++++++++ .../Beginner}/images/example.gif | Bin .../Beginner}/images/example2.gif | Bin .../{ => Knowledges/Developer}/JSON_FORMAT.md | 0 .../Developer}/rendering/CAMERA_SETTINGS.md | 0 .../Developer}/rendering/GENERAL_SETTINGS.md | 0 .../Developer}/rendering/IMAGE_OBJECTS.md | 0 .../Developer}/rendering/MDL_FILES.md | 0 .../Knowledges/Developer/rendering/OBJECTS.md | 0 .../Developer}/rendering/SOUND_OBJECTS.md | 0 .../Developer}/textures/TEXTURE_FORMAT.md | 0 docs/Knowledges/Project/Structure.md | 43 +++ docs/News Papers/Updates/! Latest.md | 2 + 18 files changed, 333 insertions(+), 269 deletions(-) create mode 100644 docs/Knowledges/Beginner/Q&A/Common Issues.md create mode 100644 docs/Knowledges/Beginner/Q&A/How to install - Wallpape Engine.md create mode 100644 docs/Knowledges/Beginner/Q&A/How to install.md rename docs/{rendering/OBJECTS.md => Knowledges/Beginner/Q&A/How to use command.md} (100%) create mode 100644 docs/Knowledges/Beginner/Q&A/How to use this.md rename docs/{ => Knowledges/Beginner}/images/example.gif (100%) rename docs/{ => Knowledges/Beginner}/images/example2.gif (100%) rename docs/{ => Knowledges/Developer}/JSON_FORMAT.md (100%) rename docs/{ => Knowledges/Developer}/rendering/CAMERA_SETTINGS.md (100%) rename docs/{ => Knowledges/Developer}/rendering/GENERAL_SETTINGS.md (100%) rename docs/{ => Knowledges/Developer}/rendering/IMAGE_OBJECTS.md (100%) rename docs/{ => Knowledges/Developer}/rendering/MDL_FILES.md (100%) create mode 100644 docs/Knowledges/Developer/rendering/OBJECTS.md rename docs/{ => Knowledges/Developer}/rendering/SOUND_OBJECTS.md (100%) rename docs/{ => Knowledges/Developer}/textures/TEXTURE_FORMAT.md (100%) create mode 100644 docs/Knowledges/Project/Structure.md create mode 100644 docs/News Papers/Updates/! Latest.md diff --git a/README.md b/README.md index 57bff45..35aa9e0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + +

@@ -16,281 +18,23 @@ Bring **Wallpaper Engine**-style live wallpapers to Linux! This project allows y > ⚠️ This is an educational project that evolved into a functional OpenGL-based wallpaper engine for Linux. Expect some limitations and quirks! ---- +## πŸš€ To install this program, please see this +- [How to install?](/docs/Knowledges/Beginner/Q&A/How%20to%20install.md) -## πŸ“¦ System Requirements +## πŸ§ͺ Usage! +- [How to use this?](/docs/Knowledges/Beginner/Q&A/How%20to%20use%20this.md) -To compile and run this, you'll need: - -- OpenGL 3.3 support -- CMake -- LZ4, Zlib -- SDL2 -- FFmpeg -- X11 or Wayland -- Xrandr (for X11) -- GLFW3, GLEW, GLUT, GLM -- MPV -- PulseAudio -- FFTW3 - -Install the required dependencies on Ubuntu/Debian-based systems: - -### Ubuntu 22.04 -```bash -sudo apt-get update -sudo apt-get install build-essential cmake libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libgl-dev libglew-dev freeglut3-dev libsdl2-dev liblz4-dev libavcodec-dev libavformat-dev libavutil-dev libswscale-dev libxxf86vm-dev libglm-dev libglfw3-dev libmpv-dev mpv libmpv1 libpulse-dev libpulse0 libfftw3-dev -``` - -### Ubuntu 24.04 -```bash -sudo apt-get update -sudo apt-get install build-essential cmake libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libgl-dev libglew-dev freeglut3-dev libsdl2-dev liblz4-dev libavcodec-dev libavformat-dev libavutil-dev libswscale-dev libxxf86vm-dev libglm-dev libglfw3-dev libmpv-dev mpv libmpv2 libpulse-dev libpulse0 libfftw3-dev -``` - ---- - -## 🐧 Arch Linux Users - -You can install this directly from the AUR using your favorite AUR helper: - -```bash -yay -S linux-wallpaperengine-git -``` - -> This installs the latest development version. - -**Note:** You’ll still need assets from the official Wallpaper Engine (via Steam). See below for details. - ---- - -## πŸš€ Getting Started - -### 1. Get Wallpaper Engine Assets - -You **must own and install Wallpaper Engine** via Steam. This provides the required assets used by many backgrounds. - -Good news: **you usually don’t need to copy anything manually.** The app will automatically look in these common install paths: - -``` -~/.steam/steam/steamapps/common -~/.local/share/Steam/steamapps/common -~/.var/app/com.valvesoftware.Steam/.local/share/Steam/steamapps/common -~/snap/steam/common/.local/share/Steam/steamapps/common -``` - -> βœ… If Wallpaper Engine is installed in one of these paths, the assets will be detected automatically! - ---- - -#### ❗ If Assets Aren’t Found Automatically - -You can copy the `assets` folder manually: - -1. In Steam, right-click **Wallpaper Engine** β†’ **Manage** β†’ **Browse local files** -2. Copy the `assets` folder -3. Paste it into the same folder where the `linux-wallpaperengine` binary is located - ---- - -### 2. Build from Source - -Clone the repo: - -```bash -git clone --recurse-submodules https://github.com/Almamu/linux-wallpaperengine.git -cd linux-wallpaperengine -``` - -Build it: - -```bash -mkdir build && cd build -cmake .. -make -``` - -Once the build process is finished, this should create a new `output` folder containing the app and all the required -support files to run. - -> βœ… Remember: Place the `assets` folder next to the built binary if it isn’t detected automatically. - ---- - -## πŸ§ͺ Usage - -Basic syntax: - -```bash -./linux-wallpaperengine [options] -``` - -You can use either: -- A Steam Workshop ID (e.g. `1845706469`) -- A path to a background folder - ---- - -### πŸ”§ Common Options - -| Option | Description | -|--------|-------------| -| `--silent` | Mute background audio | -| `--volume ` | Set audio volume | -| `--noautomute` | Don't mute when other apps play audio | -| `--no-audio-processing` | Disable audio reactive features | -| `--fps ` | Limit frame rate | -| `--window ` | Run in windowed mode with custom size/position | -| `--screen-root ` | Set as background for specific screen | -| `--bg ` | Assign a background to a specific screen (use after `--screen-root`) | -| `--scaling ` | Wallpaper scaling: `stretch`, `fit`, `fill`, or `default` | -| `--clamping ` | Set texture clamping: `clamp`, `border`, `repeat` | -| `--assets-dir ` | Set custom path for assets | -| `--screenshot ` | Save screenshot (PNG, JPEG, BMP) | -| `--list-properties` | Show customizable properties of a wallpaper | -| `--set-property name=value` | Override a specific property | -| `--disable-mouse` | Disable mouse interaction | -| `--disable-parallax` | Disable parallax effect on backgrounds that support it | -| `--no-fullscreen-pause` | Prevent pausing while fullscreen apps are running | - ---- - -### πŸ’‘ Examples - -#### Run a background by ID -```bash -./linux-wallpaperengine 1845706469 -``` - -#### Run a background from a folder -```bash -./linux-wallpaperengine ~/backgrounds/1845706469/ -``` - -#### Assign backgrounds to screens with scaling -```bash -./linux-wallpaperengine \ - --scaling stretch --screen-root eDP-1 --bg 2667198601 \ - --scaling fill --screen-root HDMI-1 --bg 2667198602 -``` - -#### Run in a window -```bash -./linux-wallpaperengine --window 0x0x1280x720 1845706469 -``` - -#### Limit FPS to save power -```bash -./linux-wallpaperengine --fps 30 1845706469 -``` - -#### Take a screenshot -```bash -./linux-wallpaperengine --screenshot ~/wallpaper.png 1845706469 -``` - -This can be useful as output for pywal or other color systems that use images as basis to generate a set of colors -to apply to your system. - -#### View and change properties -```bash -./linux-wallpaperengine --list-properties 2370927443 -``` - -The output includes all the relevant information for each of the different properties: -``` -barcount - slider - Description: Bar Count - Value: 64 - Minimum value: 16 - Maximum value: 64 - Step: 1 - -bloom - boolean - Description: Bloom - Value: 0 -frequency - combolist - Description: Frequency - Value: 2 - Posible values: - 16 -> 1 - 32 -> 2 - 64 -> 3 - -owl - boolean - Description: Owl - Value: 0 -rain - boolean - Description: Rain - Value: 1 -schemecolor - color - Description: ui_browse_properties_scheme_color - R: 0.14902 G: 0.23137 B: 0.4 A: 1 -visualizer - boolean - Description:

Add Visualizer
- Value: 1 -visualizercolor - color - Description: Bar Color - R: 0.12549 G: 0.215686 B: 0.352941 A: 1 -visualizeropacity - slider - Description: Bar Opacity - Value: 1 - Minimum value: 0 - Maximum value: 1 - Step: 0.1 - -visualizerwidth - slider - Description: Bar Spacing - Value: 0.25 - Minimum value: 0 - Maximum value: 0.5 - Step: 0.01 -``` - -Any of these values can be modified with the --set-property switch. Say you want to enable the bloom in this background, you would do so like this: -``` -./linux-wallpaperengine --set-property bloom=1 2370927443 -``` - ---- - -## πŸ§ͺ Wayland & X11 Support - -- **Wayland**: Works with compositors that support `wlr-layer-shell-unstable`. -- **X11**: Requires XRandr. Use `--screen-root ` (as shown in `xrandr`). - -> ⚠ For X11 users: Currently doesn't work if a compositor or desktop environment (e.g. GNOME, KDE, Nautilus) is drawing the background. - ---- +## πŸͺ² Common issues +- [Common Issues](/docs/Knowledges/Beginner/Q&A/Common%20Issues.md) ## 🌈 Example Backgrounds -![example1](docs/images/example.gif) -![example2](docs/images/example2.gif) +### **Want to see more examples of backgrounds that work? Head over to the [project's website](https://wpengine.alma.mu/#showcase)** -Want to see more examples of backgrounds that work? Head over to the [project's website](https://wpengine.alma.mu/#showcase) +![example1](/docs/Knowledges/Beginner/images/example.gif) +![example2](/docs/Knowledges/Beginner/images/example2.gif) -## πŸͺ² Common issues -### Black screen when setting as screen's background -This can be caused by a few different things depending on your environment and setup. - -### X11 -Common symptom of a compositor drawing to the background which prevents Wallpaper Engine from being properly visible. -The only solution currently is disabling the compositor so Wallpaper Engine can properly draw on the screen - -### NVIDIA -Some users have had issues with GLFW initialization and other OpenGL errors. These are generally something that's -worth reporting in the issues. Sometimes adding this variable when running Wallpaper Engine helps and/or solves -the issue: -```bash -__GL_THREADED_OPTIMIZATIONS=0 linux-wallpaperengine -``` - -We'll be looking at improving this in the future, but for now it can be a useful workaround. - ---- - -## πŸ™ Special Thanks +# πŸ™ Special Thanks - [RePKG](https://github.com/notscuffed/repkg) – for texture flag insights -- [RenderDoc](https://github.com/baldurk/renderdoc) – the best OpenGL debugger out there! +- [RenderDoc](https://github.com/baldurk/renderdoc) – the best OpenGL debugger out there! \ No newline at end of file diff --git a/docs/Knowledges/Beginner/Q&A/Common Issues.md b/docs/Knowledges/Beginner/Q&A/Common Issues.md new file mode 100644 index 0000000..ef51109 --- /dev/null +++ b/docs/Knowledges/Beginner/Q&A/Common Issues.md @@ -0,0 +1,23 @@ +# πŸ§ͺ Wayland & X11 Support + +- **Wayland**: Works with compositors that support `wlr-layer-shell-unstable`. +- **X11**: Requires XRandr. Use `--screen-root ` (as shown in `xrandr`). + +> ⚠ For X11 users: Currently doesn't work if a compositor or desktop environment (e.g. GNOME, KDE, Nautilus) is drawing the background. + +# Black screen when setting as screen's background +This can be caused by a few different things depending on your environment and setup. + +## X11 +Common symptom of a compositor drawing to the background which prevents Wallpaper Engine from being properly visible. +The only solution currently is disabling the compositor so Wallpaper Engine can properly draw on the screen + +## NVIDIA +Some users have had issues with GLFW initialization and other OpenGL errors. These are generally something that's +worth reporting in the issues. Sometimes adding this variable when running Wallpaper Engine helps and/or solves +the issue: +```bash +__GL_THREADED_OPTIMIZATIONS=0 linux-wallpaperengine +``` + +We'll be looking at improving this in the future, but for now it can be a useful workaround. \ No newline at end of file diff --git a/docs/Knowledges/Beginner/Q&A/How to install - Wallpape Engine.md b/docs/Knowledges/Beginner/Q&A/How to install - Wallpape Engine.md new file mode 100644 index 0000000..50e6203 --- /dev/null +++ b/docs/Knowledges/Beginner/Q&A/How to install - Wallpape Engine.md @@ -0,0 +1,48 @@ +# Buy and install: Wallpaper Engine + +You **must own and install Wallpaper Engine** via Steam. + +Install the Wallpaper Engine, this provides the required assets used by many backgrounds. + +## 1. **Install Steam** + +You can choose in your environment: + +- From official Steampowered: + 1. You can download steam in here: https://store.steampowered.com/about/ + 2. If you ended download, install the package +- Debian & Ubuntu + 1. You can install in one step command: `sudo apt install steam` +- Arch Linux + 1. In Arch Linux, Steam install is need little step, please see this ArchWiki: + - English: https://wiki.archlinux.org/title/Steam + - Japanese: https://wiki.archlinux.jp/index.php/Steam +- Fedora +- Please see official document: + - https://docs.fedoraproject.org/en-US/gaming/proton/ + +## 2. **Install the Wallpaper Engine** + +1. Buy in: https://store.steampowered.com/app/431960/Wallpaper_Engine/ +2. Install in Steam app, you can discover in Library, maybe you need to remove search conditions + +## 3. Get Wallpaper Engine Assets + +### [πŸ“°Good News!!] **You usally don't need to copy anything manually.** The app will automatically look in these common install paths: + +``` +~/.steam/steam/steamapps/common +~/.local/share/Steam/steamapps/common +~/.var/app/com.valvesoftware.Steam/.local/share/Steam/steamapps/common +~/snap/steam/common/.local/share/Steam/steamapps/common +``` + +> βœ… If Wallpaper Engine is installed in one of these paths, the assets will be detected automatically! + +### ⚠️ If Assets Aren’t Found Automatically + +You can copy the `assets` folder manually: + +1. In Steam, right-click **Wallpaper Engine** β†’ **Manage** β†’ **Browse local files** +2. Copy the `assets` folder +3. Paste it into the same folder where the `linux-wallpaperengine` binary is located \ No newline at end of file diff --git a/docs/Knowledges/Beginner/Q&A/How to install.md b/docs/Knowledges/Beginner/Q&A/How to install.md new file mode 100644 index 0000000..d84a0b2 --- /dev/null +++ b/docs/Knowledges/Beginner/Q&A/How to install.md @@ -0,0 +1,70 @@ +# πŸš€ How to Install: Linux Wallpaper Engine + +## πŸ“¦ System Requirements + +### To compile and run this, you'll need: + +- OpenGL 3.3 support +- CMake +- LZ4, Zlib +- SDL2 +- FFmpeg +- X11 or Wayland +- Xrandr (for X11) +- GLFW3, GLEW, GLUT, GLM +- MPV +- PulseAudio +- FFTW3 + +### To use this program, you'll need: + +1. **Official Wallpaper Engine's wallpaper assets (via Steam)** + 1. Let see this: [How to install - Wallpaper Engine](How%20to%20install%20-%20Wallpape%20Engine.md) + +### Install the required dependencies on Ubuntu/Debian-based systems: + +#### Ubuntu 22.04 +```bash +sudo apt-get update +sudo apt-get install build-essential cmake libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libgl-dev libglew-dev freeglut3-dev libsdl2-dev liblz4-dev libavcodec-dev libavformat-dev libavutil-dev libswscale-dev libxxf86vm-dev libglm-dev libglfw3-dev libmpv-dev mpv libmpv1 libpulse-dev libpulse0 libfftw3-dev +``` + +#### Ubuntu 24.04 +```bash +sudo apt-get update +sudo apt-get install build-essential cmake libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libgl-dev libglew-dev freeglut3-dev libsdl2-dev liblz4-dev libavcodec-dev libavformat-dev libavutil-dev libswscale-dev libxxf86vm-dev libglm-dev libglfw3-dev libmpv-dev mpv libmpv2 libpulse-dev libpulse0 libfftw3-dev +``` + +--- + +## 🐧 Arch Linux Users + +You can install this directly from the AUR using your favorite AUR helper: + +```bash +yay -S linux-wallpaperengine-git +``` + +> This installs the latest development version. + +### Build from Source + +Clone the repo: + +```bash +git clone --recurse-submodules https://github.com/Almamu/linux-wallpaperengine.git +cd linux-wallpaperengine +``` + +Build it: + +```bash +mkdir build && cd build +cmake .. +make +``` + +Once the build process is finished, this should create a new `output` folder containing the app and all the required +support files to run. + +> βœ… Remember: Place the `assets` folder next to the built binary if it isn’t detected automatically. diff --git a/docs/rendering/OBJECTS.md b/docs/Knowledges/Beginner/Q&A/How to use command.md similarity index 100% rename from docs/rendering/OBJECTS.md rename to docs/Knowledges/Beginner/Q&A/How to use command.md diff --git a/docs/Knowledges/Beginner/Q&A/How to use this.md b/docs/Knowledges/Beginner/Q&A/How to use this.md new file mode 100644 index 0000000..7ecf8be --- /dev/null +++ b/docs/Knowledges/Beginner/Q&A/How to use this.md @@ -0,0 +1,134 @@ +# πŸ§ͺ Usage + +Basic syntax: + +```bash +./linux-wallpaperengine [options] +``` + +You can use either: +- A Steam Workshop ID (e.g. `1845706469`) +- A path to a background folder + +--- + +## πŸ”§ Common Options + +| Option | Description | +|--------|-------------| +| `--silent` | Mute background audio | +| `--volume ` | Set audio volume | +| `--noautomute` | Don't mute when other apps play audio | +| `--no-audio-processing` | Disable audio reactive features | +| `--fps ` | Limit frame rate | +| `--window ` | Run in windowed mode with custom size/position | +| `--screen-root ` | Set as background for specific screen | +| `--bg ` | Assign a background to a specific screen (use after `--screen-root`) | +| `--scaling ` | Wallpaper scaling: `stretch`, `fit`, `fill`, or `default` | +| `--clamping ` | Set texture clamping: `clamp`, `border`, `repeat` | +| `--assets-dir ` | Set custom path for assets | +| `--screenshot ` | Save screenshot (PNG, JPEG, BMP) | +| `--list-properties` | Show customizable properties of a wallpaper | +| `--set-property name=value` | Override a specific property | +| `--disable-mouse` | Disable mouse interaction | +| `--disable-parallax` | Disable parallax effect on backgrounds that support it | +| `--no-fullscreen-pause` | Prevent pausing while fullscreen apps are running | + +--- + +## πŸ’‘ Examples + +### Run a background by ID +```bash +./linux-wallpaperengine 1845706469 +``` + +### Run a background from a folder +```bash +./linux-wallpaperengine ~/backgrounds/1845706469/ +``` + +### Assign backgrounds to screens with scaling +```bash +./linux-wallpaperengine \ + --scaling stretch --screen-root eDP-1 --bg 2667198601 \ + --scaling fill --screen-root HDMI-1 --bg 2667198602 +``` + +### Run in a window +```bash +./linux-wallpaperengine --window 0x0x1280x720 1845706469 +``` + +### Limit FPS to save power +```bash +./linux-wallpaperengine --fps 30 1845706469 +``` + +### Take a screenshot +```bash +./linux-wallpaperengine --screenshot ~/wallpaper.png 1845706469 +``` + +This can be useful as output for pywal or other color systems that use images as basis to generate a set of colors +to apply to your system. + +### View and change properties +```bash +./linux-wallpaperengine --list-properties 2370927443 +``` + +The output includes all the relevant information for each of the different properties: +``` +barcount - slider + Description: Bar Count + Value: 64 + Minimum value: 16 + Maximum value: 64 + Step: 1 + +bloom - boolean + Description: Bloom + Value: 0 +frequency - combolist + Description: Frequency + Value: 2 + Posible values: + 16 -> 1 + 32 -> 2 + 64 -> 3 + +owl - boolean + Description: Owl + Value: 0 +rain - boolean + Description: Rain + Value: 1 +schemecolor - color + Description: ui_browse_properties_scheme_color + R: 0.14902 G: 0.23137 B: 0.4 A: 1 +visualizer - boolean + Description:
Add Visualizer
+ Value: 1 +visualizercolor - color + Description: Bar Color + R: 0.12549 G: 0.215686 B: 0.352941 A: 1 +visualizeropacity - slider + Description: Bar Opacity + Value: 1 + Minimum value: 0 + Maximum value: 1 + Step: 0.1 + +visualizerwidth - slider + Description: Bar Spacing + Value: 0.25 + Minimum value: 0 + Maximum value: 0.5 + Step: 0.01 +``` + +Any of these values can be modified with the --set-property switch. Say you want to enable the bloom in this background, you would do so like this: +``` +./linux-wallpaperengine --set-property bloom=1 2370927443 +``` \ No newline at end of file diff --git a/docs/images/example.gif b/docs/Knowledges/Beginner/images/example.gif similarity index 100% rename from docs/images/example.gif rename to docs/Knowledges/Beginner/images/example.gif diff --git a/docs/images/example2.gif b/docs/Knowledges/Beginner/images/example2.gif similarity index 100% rename from docs/images/example2.gif rename to docs/Knowledges/Beginner/images/example2.gif diff --git a/docs/JSON_FORMAT.md b/docs/Knowledges/Developer/JSON_FORMAT.md similarity index 100% rename from docs/JSON_FORMAT.md rename to docs/Knowledges/Developer/JSON_FORMAT.md diff --git a/docs/rendering/CAMERA_SETTINGS.md b/docs/Knowledges/Developer/rendering/CAMERA_SETTINGS.md similarity index 100% rename from docs/rendering/CAMERA_SETTINGS.md rename to docs/Knowledges/Developer/rendering/CAMERA_SETTINGS.md diff --git a/docs/rendering/GENERAL_SETTINGS.md b/docs/Knowledges/Developer/rendering/GENERAL_SETTINGS.md similarity index 100% rename from docs/rendering/GENERAL_SETTINGS.md rename to docs/Knowledges/Developer/rendering/GENERAL_SETTINGS.md diff --git a/docs/rendering/IMAGE_OBJECTS.md b/docs/Knowledges/Developer/rendering/IMAGE_OBJECTS.md similarity index 100% rename from docs/rendering/IMAGE_OBJECTS.md rename to docs/Knowledges/Developer/rendering/IMAGE_OBJECTS.md diff --git a/docs/rendering/MDL_FILES.md b/docs/Knowledges/Developer/rendering/MDL_FILES.md similarity index 100% rename from docs/rendering/MDL_FILES.md rename to docs/Knowledges/Developer/rendering/MDL_FILES.md diff --git a/docs/Knowledges/Developer/rendering/OBJECTS.md b/docs/Knowledges/Developer/rendering/OBJECTS.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/rendering/SOUND_OBJECTS.md b/docs/Knowledges/Developer/rendering/SOUND_OBJECTS.md similarity index 100% rename from docs/rendering/SOUND_OBJECTS.md rename to docs/Knowledges/Developer/rendering/SOUND_OBJECTS.md diff --git a/docs/textures/TEXTURE_FORMAT.md b/docs/Knowledges/Developer/textures/TEXTURE_FORMAT.md similarity index 100% rename from docs/textures/TEXTURE_FORMAT.md rename to docs/Knowledges/Developer/textures/TEXTURE_FORMAT.md diff --git a/docs/Knowledges/Project/Structure.md b/docs/Knowledges/Project/Structure.md new file mode 100644 index 0000000..885fa28 --- /dev/null +++ b/docs/Knowledges/Project/Structure.md @@ -0,0 +1,43 @@ +# Project + +## Structure + +If you are confusing, let see this + +### Root + +### GitHub [/.github/](/.github/) + +This directory includes GitHub settings + +### Document + +- [/README.md](/README.md) + - You can see generally knowledges in this +- [/LICENSE](/LICENSE) + - This project's license +- [/docs](/docs/) + - Root + - [./README.md](/docs/README.md) + - This is your reading document + - [./Beginner/](/docs/Beginner/) + - If you are beginner, please see this + - This include Q&A and other, so maybe you can resolve your problem in this + - [./User/](/docs/User/) + - If you are user, please see this + - [./Project/](/docs/Project/) + - This project's document, if you want to contribute, please see this + - [./Developer/](/docs/Developer/) + - Document for developer + - If you are developer, please see this + +### Source Code + +- [/packaging/](/packaging/) + - This is for package building +- [/protocols/](/protocols/) + - This is for +- [/src/](/src/) + - This is source code +- [/tools/](/tools/) + - This is for \ No newline at end of file diff --git a/docs/News Papers/Updates/! Latest.md b/docs/News Papers/Updates/! Latest.md new file mode 100644 index 0000000..92e12a4 --- /dev/null +++ b/docs/News Papers/Updates/! Latest.md @@ -0,0 +1,2 @@ +# Latest Version +1. Updated documents structures \ No newline at end of file