8000 GitHub - woxels/Woxel: Native Linux / SDL2 Voxel Editor. · GitHub
[go: up one dir, main page]

Skip to content
woxelsPublic

Latest commit

 

History

318 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

woxel header

screenshot

Woxel uses intuitive controls akin to Minetest and Minecraft, while providing a design experience similar to Goxel and Magicalvoxel. Woxel paves the way to transitioning Minecraft/Minetest players to 3D asset creators for games.

💬 Join our discord! https://discord.gg/AH23bGNE2h
📱 Follow us on Twitter! https://twitter.com/Woxels

Download

Input Mapping

🏃 Movement

  • W,A,S,D = Move around based on relative orientation to X and Y.
  • SPACE + L-SHIFT = Move up and down relative Z.
  • F = Toggle player fast speed on and off.
  • 1-7 = Change move speed for selected fast state.
  • P = Toggle pitch lock.

🏗️ Interaction

  • Left Click / R-SHIFT = Place node.
  • Right Click / R-CTRL = Delete node.
  • Q / Z / Middle Click / Mouse4 = Clone color of pointed node.
  • E / Mouse5 = Replace color of pointed node.
  • R = Toggle mirror brush.
  • V = Places voxel at current position.
  • Middle Scroll = Change selected color.
  • X + C / Slash + Quote = Scroll color of pointed node.

🛠️ Settings

  • F1 = Resets environment state back to default.
  • F2 = Toggle HUD visibility.
  • F3 = Save. (auto saves on exit, backup made if idle for 3 mins.)
  • F8 = Load. (will erase what you have done since the last save)
  • ESCAPE / TAB = Toggle menu.

🖱️ Mouse locks when you click on the window, press ESCAPE / TAB to unlock the mouse.

😲 Arrow Keys or IJKL can be used to move the view around. 🤯

✔️ Your state is automatically saved on exit.

Console Arguments

📂🖱️🎨 Create or load a project, change project mouse sensitivity, or update a projects color palette

  • ./wox <project_name> <[OPTIONAL]mouse_sensitivity> <[OPTIONAL]path to color palette>
  • e.g; ./wox Untitled 0.003 /tmp/colors.txt
  • 1st, "Untitled", Name of project to open or create.
  • 2nd, "0.003", Mouse sensitivity.
  • 3rd, "/tmp/colors.txt", path to a color palette file, the file must contain a hex color on each new line, 32 colors maximum. e.g; "#00FFFF".
  • Find color palettes at; https://lospec.com/palette-list
  • You can use any palette up to 32 colors. #000000 (Black) is a valid color and does not truncate the list.

📂 Load Base64 from file

  • ./wox loadb64 <file_path>
  • e.g; ./wox loadb64 /home/user/file.b64
  • The file is adopted as a project named after the basename (so file.b64 becomes project file). F3 / exit then save file.wox.gz in the Woxel project folder.

📂 Load *.wox.gz from file

  • ./wox loadgz <file_path>
  • e.g; ./wox loadgz /home/user/file.wox.gz
  • Same adoption: you can save and export it as a normal project afterwards.

⌨️ Keymap

  • ./wox keymap writes a default keymap.txt next to the wox binary (./wox keymap ~/keys.txt to pick the path).
  • Load a specific file: ./wox --keymap-file ./mykeys.txt Untitled (also -k, --keymap, loadkeymap).
  • Search order if no flag is given:
    1. keymap.txt next to the wox binary
    2. ./keymap.txt in the current directory
    3. keymap.txt in the appdata folder (SDL_GetPrefPath / dataPath)
  • Format: action key [key ...] e.g. forward W* / look_up UP I*
  • A key name is keycode-only. Append * (W*) to also match the physical scancode.
  • Actions: forward back left right up down look_left look_right look_up look_down place delete clone replace mirror place_here fast pitch color_prev color_next hud reset save load menu speed1-speed7
  • The generated default uses W* A* S* D* and I* J* K* L* so those stay layout-independent.

🪟 Wayland custom window decorations

  • Auto-detected when the SDL video driver is Wayland. Force it on or off from the command line (flag can appear anywhere):
  • ./wox --wayland / ./wox wayland — borderless window + in-app title bar (drag, min, max, close)
  • ./wox --no-wayland / ./wox --x11 — native window decorations
  • e.g; ./wox --wayland Untitled
  • e.g; ./wox export Untitled ply ./out.ply --wayland (the flag is ignored for export-only jobs)

📂 Export as mesh or voxels

  • ./wox export <project_or_file> <[OPTIONAL]format> <[OPTIONAL]ply_mode> <export_path>
  • Formats: wox, txt, vv, ply, b64
  • PLY modes: greedy (merged same-color quads, default), quads (one quad per cube face), tris (two triangles per cube face). Greedy is always quads.
  • e.g; ./wox export untitled ply /home/user/file.ply
  • e.g; ./wox export untitled ply greedy /home/user/file.ply
  • e.g; ./wox export untitled ply quads /home/user/file.ply
  • e.g; ./wox export untitled ply tris /home/user/file.ply
  • e.g; ./wox export ./file.b64 greedy ./file.ply
  • e.g; ./wox export ./file.wox.gz txt ./file.txt
  • Source can be a saved project name, a .b64 file, or a .wox.gz file. Format can be omitted when the output path ends in .ply, .txt, .vv, .b64, or .wox.gz.

Compile

Run make or make test or cc main.c -Ofast -lm -lz -lSDL2 -lGLESv2 -lEGL -o wox

cc main.c -Ofast -lm -lz -lSDL2 -lGLESv2 -lEGL -o wox
./wox

Similar Software

Info

0