Skip to content

Latest commit

 

History

History
167 lines (121 loc) · 5.91 KB

README.md

File metadata and controls

167 lines (121 loc) · 5.91 KB
Raw

Contributors Forks Stargazers Issues License


ProjectM

Reference projectM application in Rust, utilizing the projectM crate

Report Bug · Request Feature


Table of Contents
  1. Getting Started
  2. Usage
  3. Contributing
  4. License
  5. Support
  6. Contact

Getting Started

To get this crate up and running properly, you'll need to install some prerequisites.

Prerequisites

Depending on the OS/distribution and packaging system, libraries might be split into separate packages with binaries and development files. To build projectM, both binaries and development files need to be installed.

General build dependencies for all platforms:

  • Rust
  • A working build toolchain.
  • CMake: Used to generate platform-specific build files.
  • OpenGL: 3D graphics library. Used to render the visualizations.
  • or GLES3: OpenGL libraries for embedded systems, version 3. Required to build projectM on Android devices, Raspberry Pi, Emscripten and the Universal Windows Platform.
  • glm: OpenGL Mathematics library. Optional, will use a bundled version with autotools or if not installed.
  • SDL3: Simple Directmedia Layer >= 3. Provided by sdl3-rs. the test UI.
  • LLVM: Low-Level Virtual Machine. Optional and experimental, used to speed up preset execution by leveraging the LLVM JIT compiler.

Only relevant for Windows:

  • vcpkg: C++ Library Manager for Windows. Optional, but recommended to install the aforementioned library dependencies.
  • GLEW: The OpenGL Extension Wrangler Library. Only required if using CMake to configure the build, the pre-created solutions use a bundled copy of GLEW.

(back to top)

Usage

// run app
cargo run

// build app
cargo build

If using SDL installed via Homebrew

RUSTFLAGS="-L$(brew --prefix sdl3)/lib" cargo build
RUSTFLAGS="-L$(brew --prefix sdl3)/lib" cargo run

Optimized build

cargo run --release

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the LGPL-2.1 license. See LICENSE for more information.

(back to top)

Support

Discord

(back to top)

Contact

Blaquewithaq (Discord: SoFloppy#1289) - @anomievision - anomievision@gmail.com

(back to top)