JeremyStarTM
b5acd36479
- [src/*] Update comments - [src/*] Improve code quality - [export_presets.cfg] All exports use a console wrapper now - [src/console.gd] Add highlighting for "arbitrary" command - [src/console.gd] Add special message if nothing has been typed in - [src/misc.gd, src/console.gd] Move BooleanState, get_last() (now called get_shortened_array), get_boolean(), get_int() and get_int_direct() into misc - [src/console_info.gd] Remove useless _init() function - [src/console_info.gd] Make get_error_string() function more compact - [Loader.tscn, src/loader.gd] Remove window size support and slow initialization functionality - [src/loader.gd] Remove warning on startup (will be reimplemented at some point, most likely graphically) - [src/loader.gd] Replaced append_log() function with a lambda - [src/loader.gd] Implement argument parser with configuration support - [src/loader.gd] Add Presencode version information as constants and format_version() function - [src/misc.gd] Reorganize functions - [src/pmana.gd] Add checks to avoid slide change collisions - [src/pmana.gd] Replace logger.warn() calls to "await logger.error()" calls - [src/pmana.gd, src/misc.gd, src/console.gd] Remove pmana.shutdown() function in favour of misc.shutdown() which now does the same - [src/preader.gd] Fix resource loading issues for presentation directories - [src/preader.gd] Move resource loading workaround into seperate function _read_resource_workaround() - [src/processor.gd, src/console.gd, src/loader.gd, src/pmana.gd, src/ui_engine.gd] Move all _process() functions into seperate file - [src/processor.gd, src/console.gd, src/loader.gd, src/pmana.gd, src/ui_engine.gd, src/ui/welcome.gd] Move everything dragging related (except variables) into processor.gd - [ui/Welcome.tscn, src/ui/welcome.gd] Add support for presentation directories - [src/ui/welcome.gd] Update splash text |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| docusaurus.config.ts | ||
| Makefile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.ts | ||
| tsconfig.json | ||
Presencode documentation
The Presencode documentation uses Docusaurus.
Commands
We use make.
Installing dependencies
$ make install-deps
pnpm install
Downloading registry.npmjs.org/typescript/5.2.2: 7,23 MB/7,23 MB, done
WARN 1 deprecated subdependencies found: stable@0.1.8
Packages: +1088
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Progress: resolved 1089, reused 0, downloaded 1088, added 1088, done
node_modules/.pnpm/core-js-pure@3.35.0/node_modules/core-js-pure: Running postinstall script, done in 92ms
node_modules/.pnpm/core-js@3.35.0/node_modules/core-js: Running postinstall script, done in 92ms
dependencies:
+ @docusaurus/core 3.1.0
+ @docusaurus/plugin-content-docs 3.1.0
+ @docusaurus/plugin-sitemap 3.1.0
+ @docusaurus/preset-classic 3.1.0
+ @mdx-js/react 3.0.0
+ clsx 2.1.0
+ prism-react-renderer 2.3.1
+ react 18.2.0
+ react-dom 18.2.0
devDependencies:
+ @docusaurus/module-type-aliases 3.1.0
+ @docusaurus/tsconfig 3.1.0
+ @docusaurus/types 3.1.0
+ typescript 5.2.2 (5.3.3 is available)
Done in 18.1s
Development web server
This will start a development server that supports hot reloading.
$ make test
pnpm run start --hot-only --no-open
> docs@0.0.0 start /home/jeremystartm/Code/JeremyStarTM/Presencode/docs
> docusaurus start "--hot-only" "--no-open"
(node:138150) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at: http://localhost:3000/
✔ Client
Compiled successfully in 4.40s
client (webpack 5.89.0) compiled successfully
Building the documentation
This will output the built documentation to out/. Simply point a web server to it and you're done.
$ make build
pnpm run build --out-dir out
> docs@0.0.0 build /home/jeremystartm/Code/JeremyStarTM/Presencode/docs
> docusaurus build "--out-dir" "out"
(node:139592) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
[INFO] [en] Creating an optimized production build...
✔ Client
✔ Server
Compiled successfully in 11.36s
✔ Client
● Server █████████████████████████ cache (99%) shutdown IdleFileCachePlugin
stored
[SUCCESS] Generated static files in "out".
[INFO] Use `npm run serve` command to test your build locally
Cleaning the directory
This will remove the out/ directory containing the built website aswell as Docusaurus files.
$ make clean
pnpm run clear
> docs@0.0.0 clear /home/jeremystartm/Code/JeremyStarTM/Presencode/docs
> docusaurus clear
(node:140318) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
[SUCCESS] Removed the generated folder at "/home/jeremystartm/Code/JeremyStarTM/Presencode/docs/.docusaurus".
[SUCCESS] Removed the Webpack persistent cache folder at "/home/jeremystartm/Code/JeremyStarTM/Presencode/docs/node_modules/.cache".
rm -rf "out" ".docusaurus" ".cache-loader"
More cleaning
This will remove the node_modules/ and pnpm-lock.yaml directory aswell.
$ make clean-extra
pnpm run clear
> docs@0.0.0 clear /home/jeremystartm/Code/JeremyStarTM/Presencode/docs
> docusaurus clear
(node:141571) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
[SUCCESS] Removed the generated folder at "/home/jeremystartm/Code/JeremyStarTM/Presencode/docs/.docusaurus".
[SUCCESS] Removed the Webpack persistent cache folder at "/home/jeremystartm/Code/JeremyStarTM/Presencode/docs/node_modules/.cache".
rm -rf "out" ".docusaurus" ".cache-loader"
rm -rf "node_modules" "pnpm-lock.yaml"