diff --git a/Doxyfile b/Doxyfile
index 31235d6..9fc1ab9 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -54,21 +54,21 @@ PROJECT_NUMBER = v0.1.0
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF = "Snake AI Game in Unity"
+PROJECT_BRIEF = "Snake Game - AI Edition"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
-PROJECT_LOGO = C:/Users/felix/SnakeGame/docs/images/logo.png
+PROJECT_LOGO = ./logo.svg
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
-OUTPUT_DIRECTORY = ../
+OUTPUT_DIRECTORY = docs
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
@@ -1097,8 +1097,7 @@ EXAMPLE_RECURSIVE = NO
# \image command).
IMAGE_PATH = images \
- docs/images
-
+ docs/img
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
@@ -1397,10 +1396,10 @@ HTML_STYLESHEET =
# documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_EXTRA_STYLESHEET = doxygen-custom/doxygen-awesome.css \
+HTML_EXTRA_STYLESHEET = doxygen-awesome.css \
doxygen-custom/custom.css \
- doxygen-custom/doxygen-awesome-sidebar-only.css \
- doxygen-custom/doxygen-awesome-sidebar-only-darkmode-toggle.css \
+ doxygen-awesome-sidebar-only.css \
+ doxygen-awesome-sidebar-only-darkmode-toggle.css \
doxygen-custom/custom-alternative.css
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
@@ -1411,12 +1410,12 @@ HTML_EXTRA_STYLESHEET = doxygen-custom/doxygen-awesome.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_EXTRA_FILES = doxygen-custom/doxygen-awesome-darkmode-toggle.js \
- doxygen-custom/doxygen-awesome-fragment-copy-button.js \
- doxygen-custom/doxygen-awesome-paragraph-link.js \
+HTML_EXTRA_FILES = doxygen-awesome-darkmode-toggle.js \
+ doxygen-awesome-fragment-copy-button.js \
+ doxygen-awesome-paragraph-link.js \
doxygen-custom/toggle-alternative-theme.js \
- doxygen-custom/doxygen-awesome-interactive-toc.js \
- doxygen-custom/doxygen-awesome-tabs.js
+ doxygen-awesome-interactive-toc.js \
+ doxygen-awesome-tabs.js
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
diff --git a/ProjectSettings/ProjectSettings.asset b/ProjectSettings/ProjectSettings.asset
index 2d62250..9db1722 100644
--- a/ProjectSettings/ProjectSettings.asset
+++ b/ProjectSettings/ProjectSettings.asset
@@ -136,8 +136,7 @@ PlayerSettings:
vulkanEnableCommandBufferRecycling: 1
loadStoreDebugModeEnabled: 0
bundleVersion: 0.1.0-alpha.1
- preloadedAssets:
- - {fileID: 11400000, guid: fe255ffce795bc04384b74d57c2c56e4, type: 2}
+ preloadedAssets: []
metroInputSource: 0
wsaTransparentSwapchain: 0
m_HolographicPauseOnTrackingLoss: 1
@@ -146,7 +145,7 @@ PlayerSettings:
vrSettings:
enable360StereoCapture: 0
isWsaHolographicRemotingEnabled: 0
- enableFrameTimingStats: 1
+ enableFrameTimingStats: 0
enableOpenGLProfilerGPURecorders: 1
useHDRDisplay: 0
hdrBitDepth: 0
diff --git a/README.md b/README.md
index 8db4494..1b3438d 100644
--- a/README.md
+++ b/README.md
@@ -9,15 +9,20 @@
[//]: # ([![LinkedIn][linkedin-shield]][linkedin-url])
-
-
+
+
+
-
-
+[//]: # (This is for the doxygen)
+[//]: # ()
+
+
+
+
SnakeGame - AI Edition
@@ -68,8 +73,10 @@
## About The Project
-[![Example training with tensorboard and mlagents][product-screenshot]](https://github.com/Pristar4//images/product-screenshot.png)
-
+
+
+
+
This project is about making a sophisticated AI that can play the classic Snake Game efficiently.
The goal was not only to cultivate the AI's ability to survive in the game, but also to potentially
@@ -134,7 +141,8 @@ Perform the following steps to set up and run the project:
```
tensorboard --logdir results
```
-7. Enter the Play mode in the Unity editor in the AI scene under ``SnakeGame\Assets\SnakeGame\_Levels\AI``.
+7. Enter the Play mode in the Unity editor in the AI scene
+ under ``SnakeGame\Assets\SnakeGame\_Levels\AI``.
diff --git a/docs/customization.md b/docs/customization.md
new file mode 100644
index 0000000..15e5014
--- /dev/null
+++ b/docs/customization.md
@@ -0,0 +1,115 @@
+# Customization
+
+[TOC]
+
+
+## CSS-Variables
+
+This theme is highly customizable because a lot of things are parameterized with CSS variables.
+
+Just to give you an idea on how flexible the styling is, click this button:
+
+
Alter theme
+
+### Setup
+
+It is recommended to add your own `custom.css` and overwrite the variables there:
+```
+HTML_EXTRA_STYLESHEET = doxygen-awesome.css custom.css
+```
+
+Make sure to override the variables in the correct spot. All variables should be customized where they have been defined, in the `html` tag selector:
+
+```css
+html {
+ /* override light-mode variables here */
+}
+```
+
+For dark-mode overrides you have to choose where to put them, depending on whether the dark-mode toggle extension is installed or not:
+
+
+
+- dark-mode toggle is installed
+ ```css
+ html.dark-mode {
+ /* define dark-mode variable overrides here if you DO use doxygen-awesome-darkmode-toggle.js */
+ }
+ ```
+- dark-mode toggle is **NOT** installed
+ The dark-mode is enabled automatically depending on the system preference:
+ ```css
+ @media (prefers-color-scheme: dark) {
+ html:not(.light-mode) {
+ /* define dark-mode variable overrides here if you DON'T use doxygen-awesome-darkmode-toggle.js */
+ }
+ }
+ ```
+
+
+
+### Available variables
+
+The following list gives an overview of the variables defined in [`doxygen-awesome.css`](https://github.com/jothepro/doxygen-awesome-css/blob/main/doxygen-awesome.css).
+
+The list is not complete. To explore all available variables, have a look at the CSS starting from [here](https://github.com/jothepro/doxygen-awesome-css/blob/main/doxygen-awesome.css#L30).
+All variables are defined at the beginning of the stylesheet.
+
+| Parameter | Default (Light) | Default (Dark) |
+| :---------------------------------- | :---------------------------------------------------------- | :---------------------------------------------------------- |
+| **Color Scheme**: primary theme colors. This will affect the entire websites color scheme: links, arrows, labels, ... |||
+| `--primary-color` | #1779c4 | #1982d2 |
+| `--primary-dark-color` | #335c80 | #5ca8e2 |
+| `--primary-light-color` | #70b1e9 | #4779ac |
+| **Page Colors**: background and foreground (text-color) of the documentation. |||
+| `--page-background-color` | #ffffff | #1C1D1F |
+| `--page-foreground-color` | #2f4153 | #d2dbde |
+| `--page-secondary-foreground-color` | #6f7e8e | #859399 |
+| **Spacing:** default spacings. Most ui components reference these values for spacing, to provide uniform spacing on the page. |||
+| `--spacing-small` | `5px` | |
+| `--spacing-medium` | `10px` | |
+| `--spacing-large` | `16px` | |
+| **Border Radius**: border radius for all rounded ui components. Will affect many components, like dropdowns, memitems, codeblocks, ... |||
+| `--border-radius-small` | `4px` | |
+| `--border-radius-medium` | `6px` | |
+| `--border-radius-large` | `8px` | |
+| **Content Width**: The content is centered and constrained in its width. To make the content fill the whole page, set the following variable to `auto`. |||
+| `--content-maxwidth` | `1000px` | |
+| **Code Fragment Colors**: Color-Scheme of multiline codeblocks |||
+| `--fragment-background` | #F8F9FA | #282c34 |
+| `--fragment-foreground` | #37474F | #dbe4eb |
+| **Arrow Opacity**: By default the arrows in the sidebar are only visible on hover. You can override this behavior so they are visible all the time. |||
+| `--side-nav-arrow-opacity` | `0` | |
+| `--side-nav-arrow-hover-opacity` | `0.9` | |
+| ...and many more |||
+
+
+If you miss a configuration option or find a bug, please consider [opening an issue](https://github.com/jothepro/doxygen-awesome-css/issues)!
+
+## Doxygen generator
+
+The theme overrides most colors with the `--primary-color-*` variables.
+
+But there is a few small images and graphics that the theme cannot adjust or replace. To make these blend in better with
+the rest, it is recommended to adjust the [doxygen color settings](https://www.doxygen.nl/manual/customize.html#minor_tweaks_colors)
+to something that matches the chosen color-scheme.
+
+For the default color-scheme, these values work out quite well:
+
+```
+# Doxyfile
+HTML_COLORSTYLE_HUE = 209
+HTML_COLORSTYLE_SAT = 255
+HTML_COLORSTYLE_GAMMA = 113
+```
+
+## Share your customizations
+
+If you customized the theme with custom colors, spacings, font-sizes, etc. and you want to share your creation with others, you can to this [here](https://github.com/jothepro/doxygen-awesome-css/discussions/13).
+
+I am always curious to learn about how you made the theme look even better!
+
+
+
+Read Next: [Tips & Tricks](tricks.md)
+
\ No newline at end of file
diff --git a/docs/extensions.md b/docs/extensions.md
new file mode 100644
index 0000000..415a15b
--- /dev/null
+++ b/docs/extensions.md
@@ -0,0 +1,236 @@
+# Extensions
+
+[TOC]
+
+On top of the base theme provided by `doxygen-awesome.css`, this repository comes with Javascript extensions that require additional setup steps to get them running.
+
+The extensions require customizations in the header HTML-template.
+This is how you can create the default template with Doxygen:
+
+1. Create default header template:
+ ```sh
+ doxygen -w html header.html delete_me.html delete_me.css
+ ```
+
+2. Reference the template in your `Doxyfile`:
+ ```
+ HTML_HEADER = header.html
+ ```
+
+[More details on header customization](https://www.doxygen.nl/manual/customize.html#minor_tweaks_header_css)
+
+## Dark Mode Toggle {#extension-dark-mode-toggle}
+
+Adds a button next to the search bar to enable and disable the dark theme variant manually:
+
+
+
+
+
+### Installation
+
+1. Add the required resources in your `Doxyfile`:
+ - **HTML_EXTRA_FILES:** `doxygen-awesome-darkmode-toggle.js`
+ - **HTML_EXTRA_STYLESHEET:** `doxygen-awesome-sidebar-only-darkmode-toggle.css`
+ (ONLY required for the sidebar-only theme variant!)
+2. In the `header.html` template, include `doxygen-awesome-darkmode-toggle.js` at the end of the `` and then initialize it:
+ ```html
+
+
+
+
+
+
+
+ ```
+
+### Customizing
+
+Changing the tooltip of the button:
+```js
+DoxygenAwesomeDarkModeToggle.title = "Zwischen hellem/dunklem Modus wechseln"
+```
+
+Changing Icons. Both Emoji or SVG icons are supported:
+```js
+DoxygenAwesomeDarkModeToggle.lightModeIcon = '🌞'
+// icon from https://fonts.google.com/icons
+DoxygenAwesomeDarkModeToggle.darkModeIcon = ``
+```
+
+All customizations must be applied before calling `DoxygenAwesomeDarkModeToggle.init()`!
+
+
+## Fragment Copy Button {#extension-copy-button}
+
+Shows a copy button when the user hovers over a code fragment:
+
+
+
+
+
+### Installation
+
+1. Add the required resources in your `Doxyfile`:
+ - **HTML_EXTRA_FILES:** `doxygen-awesome-fragment-copy-button.js`
+2. In the `header.html` template, include `doxygen-awesome-fragment-copy-button.js` at the end of the `` and then initialize it:
+ ```html
+
+
+
+
+
+
+
+ ```
+
+### Customizing
+
+The tooltip of the button can be changed:
+```js
+DoxygenAwesomeFragmentCopyButton.title = "In die Zwischenablage kopieren"
+```
+
+The icon can be changed. It must be an SVG:
+```js
+DoxygenAwesomeFragmentCopyButton.copyIcon = `
-
+[//]: # (This is for the doxygen)
+[//]: # ()
+
+
+
+
+
+