flamenco-env/readme.md

# Flamenco ENV
Various scripts and stuff for Flamenco setup.

# Flamenco Setup
The [Quickstart Guide](https://flamenco.blender.org/usage/quickstart/) has most resources you need, (although it's pretty vague).
A more detailed setup can be found below, although these are intended specifically for linux environments.

## Setup NFS (Or Other File Server Equivalent)
1. Ensure you have valid `nfs` support
    - On Arch `gvfs-nfs` is package name
    - On Debian: `$ sudo apt install gvfs nfs-common`
2. Ensure we have a directory to mount to: `$ sudo mkdir -p srv/flamenco`
3. Mount said directory: `$ sudo mount -t nfs {hostname}:/srv/flamenco srv/flamenco`

## Setup Blender
1. Install specified [Blender](https://download.blender.org/release/) version
2. Add the Blender directory/executable to your PATH (can be an environment variable) so running `blender` runs the software
3. For everyone (*optional* for Manager), configure Blender:
    - Workers and end-user **MUST** have Flamenco add-on, need to install from file downloaded from your Flamenco manager
    - Install other extensions as needed
    - Configure Blender for GPU rendering

## Manager
1. First, [setup Blender](#setup-blender)
2. Download appropiate Flamenco version from [their site](https://flamenco.blender.org/download/)
3. Unpack the contents, run `flamenco-manager`
4. In a browser, go to the system IP address at port 8080 (`localhost:8080`) and answer the Flamenco setup questions
5. Flamenco will restart, and should show the regular Flamenco Interface. All done!

## Worker
1. First, [setup Blender](#setup-blender)
3. Download appropiate Flamenco version from [their site](https://flamenco.blender.org/download/)
4. Unpack the contents, run `flamenco-worker`
5. Your worker should show under the `Workers` tab of the Flamenco Manager. All done!

## End-User
If you want to submit a Flamenco job, go to the `Output` tab in your Blender file,
scroll to the Flamenco section at the bottom, and configure accordingly.
Be sure to select your output and job type.

Upon submitting a job, your file should be automatically packed and sent to Flamenco. Congrats!

# Development
For writing Python, you'll want to download the Blender Autocomplete repository.
`$ git clone https://github.com/Korchy/blender_autocomplete.git`

- [Installing Extensions via Terminal](https://docs.blender.org/manual/en/latest/advanced/command_line/extension_arguments.html)
- [Rendering from Command-Line](https://docs.blender.org/manual/en/latest/advanced/command_line/render.html)