Skip to content

Szmelc-INC/Zen-Docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cDvD

Project Title

Project description...

Desc 2...

stars forks contributors pull requests last commit
discord youtube website


Tip

Demo / Screenshots 🎬

Demo / Scr title

desc misc

short demo

Important

Setup

example command

git clone https://github.com/Szmelc-INC/Zen-Docs && cd Zen-Docs

desc 2

make && sudo make install && make clean

Note

Info

desc

desc

TITLE

Data tables / Info

some value value 2 3
Example / 2 / 3 4
Whatever E
XYZ / AAA / BBB CCC

Tip

Details on usage and available options

Usage

cdvd [-f fps] [-s speed] [-t decay_sec] [-L logo.txt] [--info] [--mask-edges|--mask-blanks]

Hotkeys (at runtime)

Action Key(s)
Toggle trail t
Toggle info HUD i
Speed ± /
FPS ± /
Decay ± y / u

Important

Build

You can change logo to anything you preffer before compilation, to bake it into binary, or with a -L flag in runtime
Make sure you have logo.txt with ASCII art before compiling \

Buld

With Makefile:

#   make                 # build
#   make run             # run with nice defaults
#   sudo make install    # install to /bin/cdvd  (override BINDIR/INSTALL_NAME)
#   sudo make uninstall  # remove installed binary
#   make clean           # clean artifacts

Alternatively run bash compile.sh
Or manually: Convert logo.txt to inc before compilation

xxd -i -n dvd_logo logo.txt > logo.inc

Compile

export LANG=en_US.UTF-8
gcc -O2 -Wall -Wextra -std=c11 dvd_ascii.c -lncursesw -lm -o dvd

Note

Custom logos

  • Provide your own ASCII/UTF‑8 art via -L path/to/logo.txt at runtime.

Default logo.txt

⠀⠀⣸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⢀⣾⣿⣿⣿⣿⣿⣿⣿⣿⣶⣦⡀
⠀⢠⣿⣿⡿⠀⠀⠈⢹⣿⣿⡿⣿⣿⣇⠀⣠⣿⣿⠟⣽⣿⣿⠇⠀⠀⢹⣿⣿⣿
⠀⢸⣿⣿⡇⠀⢀⣠⣾⣿⡿⠃⢹⣿⣿⣶⣿⡿⠋⢰⣿⣿⡿⠀⠀⣠⣼⣿⣿⠏
⠀⣿⣿⣿⣿⣿⣿⠿⠟⠋⠁⠀⠀⢿⣿⣿⠏⠀⠀⢸⣿⣿⣿⣿⣿⡿⠟⠋⠁⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⣀⣀⣸⣟⣁⣀⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⣠⣴⣶⣾⣿⣿⣻⡟⣻⣿⢻⣿⡟⣛⢻⣿⡟⣛⣿⡿⣛⣛⢻⣿⣿⣶⣦⣄⡀⠀
⠉⠛⠻⠿⠿⠿⠷⣼⣿⣿⣼⣿⣧⣭⣼⣿⣧⣭⣿⣿⣬⡭⠾⠿⠿⠿⠛⠉⠀

Or bake it in at compile time using the xxd step above.

  • Make sure your terminal font supports the characters you use.

Warning

Logos / Banners

Images / Logos

Banners
long

long

Logos
long

long
---

Caution

DETAILS

Requirements

  • A POSIX‑y environment (Linux, BSD, macOS).
  • ncursesw, gcc/clang, and make (if using the Makefile).
  • UTF‑8 locale (e.g., LANG=en_US.UTF-8).

📝 Notes

  • Terminal size affects bounce boundaries (resizing is handled on the fly).
  • For best visuals, use a font with good box‑drawing / block character coverage.
  • Also, Important to note is, this project was mostly just Vibe Coded with much help from an A.I assistant,
  • while I took it as a learning opportunity with a project that does not neceaseaarly have to be fully understood right away and memory safe!

🤝 Contribute

Looking for a project to contribute?

I kinda need help with repackaging & maintaining it for different platforms, If you want to help, hit me up on Discord, Email or by any means.
Email Discord

About

Documentation templates and design notes

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors