Coder Social home page Coder Social logo

foundryvtt-scenery's Introduction

Scenery - Background Image Variation Manager

All Releases Download Count Latest Release Download Count GitHub release (latest by date) Foundry Core Minimal Compatible Version Forge Installs ko-fi Patreon

Weblate Translation Status

A FoundryVTT module that allows easy import and background image changes for variations such as GM/Player, Night, Seasonal, etc.

Scenery UI

To open the scenery config, right-click a scene in either the top scene navigation, or the scenes directory in the sidebar, and select "Scenery".

Features

  • Assign variations to be easily switched between
  • Choose a different background to be shown to Players and GM
  • Automatically find and import variations

How to setup variations

When scanning for variations, scenery works as follows:

  • Based on the default image of the scene (set in core scene configuration)
  • Will only look for variation images in the same directory
  • Variation file names must contain the base file name of the default image, minus the extension
  • Variation names will have special characters removed and any dashes or underscores converted to spaces

For example, if your default map is maps/forest-camp/Forest-Camp.jpg, Scenery will find the following:

  • maps/forest-camp/Forest-Camp-GM.jpg
  • maps/forest-camp/Forest-Camp2.jpg
  • maps/forest-camp/2.Forest-Camp.jpg
  • maps/forest-camp/Forest-Camp-alt.png
  • maps/forest-camp/Night-Forest-Camp.webp

Scenery will not consider the following examples to be variations of maps/forest-camp/Forest-Camp.jpg:

  • maps/some-other-dir/Forest-Camp-GM.jpg (is not in same directory)
  • maps/forest-camp/night.jpg (does not contain base name)
  • maps/forest-camp/forestcamp-night.jpg (Base name has no exact match in variation name)

Example how to set up your directory:

Filename Example

Installation

Method 1:

  • Start Foundry and head to the Add-on Modules tab.
  • Click Install Module.
  • Search for "Scenery".
  • Click the Install button when it comes up.

Method 2:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.