Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blob-cc/processing-docker

Processing | Docker
https://github.com/blob-cc/processing-docker

blob devcontainer docker processing

Last synced: about 1 month ago
JSON representation

Processing | Docker

Awesome Lists containing this project

README

        

# Processing devContainer

This project provides a Processing development environment within a Docker container, fully equipped with popular Processing libraries. This setup ensures a consistent development environment for all users and simplifies the setup process.

## Features

- **Consistent Development Environment**: Everything runs inside a Docker container, ensuring that all developers have the same setup and dependencies.
- **Pre-installed Libraries**: Includes popular Processing libraries such as Sound, Video, ControlP5, and ToxicLibs for advanced functionalities.
- **Example Sketch**: A simple example sketch is included to demonstrate how to start creating Processing sketches immediately.

## Structure

``` lua
/YourProject
|-- .devcontainer
| |-- devcontainer.json
| |-- Dockerfile
|-- examples
| |-- ExampleSketch
| |-- ExampleSketch.pde
|-- README.md
```

## Prerequisites

- **Docker**: You must have Docker installed and running on your machine. [Get Docker](https://www.docker.com/get-started)
- **Visual Studio Code**: VS Code with the Remote - Containers extension installed. [Download VS Code](https://code.visualstudio.com/Download)
- **X Server**: For GUI applications, an X Server is required:
- **Linux**: X11 should already be installed.
- **Windows**: Install VcXsrv or Xming.
- **macOS**: Install XQuartz.

## Getting Started

1. **Clone the Repository**

```bash
git clone
cd
```

2. **Open with VS Code**
Open the project folder in VS Code. When prompted, click on `Reopen in Container` to start building the container. This may take a few minutes the first time.

3. **Run the Example Sketch**
Once the container is ready, the example sketch located in `examples/ExampleSketch/ExampleSketch.pde` will automatically run, displaying a moving ball across the screen.

## Using the Environment

- **Developing Your Sketches**: You can add new sketches or modify existing ones in the `/workspace` directory.
- **Running Sketches**: Use the command below to run your Processing sketches:

```bash
processing-java --sketch=/workspace/your-sketch-folder --run
```

## Included Libraries

Here are the libraries included in this DevContainer setup:

- **Sound**: For audio processing.
- **Video**: For video capturing and rendering.
- **ControlP5**: For creating interactive GUI elements.
- **ToxicLibs**: Comprehensive toolkit for graphics, physics, and more.

Refer to the respective library documentation for detailed usage instructions.

## Troubleshooting

- **GUI not Displaying**: Ensure your X Server is configured to allow connections from `localhost`.
- **Library Errors**: If a library fails to load, verify that it's correctly installed in the `/opt/processing/modes/java/libraries` directory.

---

## Colophon

Made with ❤️ by **[Scape Agency](https://www.scape.agency)**

### Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

### License

This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.

---

## Resources

- https://github.com/processing/processing
- https://github.com/processing/processing-library-template

### Plugins

- https://github.com/yconst/ReactP5
- https://github.com/atduskgreg/opencv-processing