README.txt
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

README.txt
View Options

	@%@~LICENSE:OK~@%@

	K-OS
	====

	Developed using Python 3.9.6 on Gentoo (pygame 2.1.0 / pytube / ffmpeg 4.4).

	Run the file named: start.py
	in this directory

	Examples:: ./start.py
	python3 start.py


	(Optional) DIP-switches
	[ specify on command-line ]

	0: No Meta
	1: Single-Threaded (No ImageEngine)
	2: No Online
	3: No Governor
	4: No Shadow
	6: No Replay
	9: Full-Screen

	Examples:: ./start.py 206
	python3 start.py 91


	Folders
	-------

	Folders in this project directory are used as follows:

	+ a - ack/art/annotated (blackboard saves)
	+ d - downloaded media (YouTube)
	+ g - graphics
	+ k - killer source code (python!)
	+ p - project stuff (thumbnails)
	+ r - replay capture (screenshots)


	== WEB UI ==

	=== Backend ===

	Activate virtual environment...
	```
	python -m venv venv
	source venv/bin/active
	```

	...then install the dependencies...
	```
	pip install -r requirements.txt
	```

	...and launch:
	```
	./svelte.py
	```

	=== Frontend ===

	Install the dependencies...

	```
	npm install
	```

	...and launch ([Rollup](https://rollupjs.org)):

	```
	npm run dev
	```

	Navigate to [localhost:8080](http://localhost:8989).


	== Author ==

	by LANNOCC