# Venus

Venus is a comprehensive HTML5 game platform and development ecosystem that provides hosting, distribution, and management services for web-based games. It serves as the publishing destination where developers can upload, version, and publish their HTML5 games to make them accessible to users through the Explore tab. Venus integrates with the Venus SDK for game development and the Vibeforge CLI for seamless game submission, versioning, publishing, and instance management workflows.

## Vibeforge

Vibeforge attempts to automate the publication of games to venus. However, there is only so much that can be automated without specifications for how a project must look.

When working with HTML5 games for Venus, always ensure your project follows one of these patterns:

1. **Built Project Structure**: Create a build output directory named `/dist`, `/build`, or `/output` containing your compiled game files
2. **Package.json with Build Script**: If no build directory exists, ensure there's a `package.json` file with a `build` script that generates production-ready game files

The Vibeforge CLI follows this workflow:

- Searches for existing build directories (`/dist`, `/build`, `/output`) first
- If none found, looks for `package.json` with a build script and executes it
- Uploads only the built files (never source code) to Venus platform

**Code Guidelines**: Always exclude development files like `src/`, `node_modules/`, or raw source code from your build folder. Focus on production-ready, built game files only.

### How to use the cli

run `vf` to see a list of possible commands.

for detailed documents of individual commands run `vf [command] -h` or `vf [command] --help` where [command] is the command you are wanting information for.
I