You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
rmemr 8bed103b23 + support for automatic extraction of custom quest function templates from scripts folder in project 3 weeks ago
imgui ~ fixed some clippy warnings 1 month ago
logger@0fdc65dca7 ~ fixed/silenced some clippy warnings 4 months ago
repo.quests + minimal repo to allow editor startup 1 year ago
src + support for automatic extraction of custom quest function templates from scripts folder in project 3 weeks ago
w3.definitions@6b82433853 ~ fixed some clippy warnings 1 month ago
w3.model@f3d999ee91 ~ fixed some clippy warnings 1 month ago
.gitignore + project init 3 years ago
.gitmodules + first version of reading (relevant part of) quest definition and displaying segment and segment block lists in a questgraph mode 2 years ago
Cargo.toml + support for automatic extraction of custom quest function templates from scripts folder in project 3 weeks ago
README.md Added powershell in build section, dumb commit. WSL2 cross-compiling is still a bit of a hassle, but even moreso is cmd.exe 4 months ago
example.screenshot.png + some info about repository 1 year ago
help.txt ~ slightly extended help info for interaction/scene blocks 11 months ago

README.md

Witcher 3 Questgraph Editor

A questgraph editor for "The Witcher 3: Wild Hunt" game by CD Projekt Red, part of radish community modding tools.

Example Screenshot

radish modding tools are a collection of community created modding tools aimed to enable the creation of new quests for "The Witcher 3: Wild Hunt" game by CDPR.

The full package will be available here: https://www.nexusmods.com/witcher3/mods/3620

Building from Source

The project can be compiled with the stable rust-toolchain version 1.36 or higher. Windows platform requires the MSVC toolchain.

  1. Clone with all submodules:

    $ git clone --recurse-submodules https://codeberg.org/rmemr/w3.questeditor.git
    
  2. The environment variables GIT_HASH and BUILD_TIME must be set prior building, e.g. in linux

    $ export GIT_HASH=dev-build; export BUILD_TIME=dev-build;
    

    or in windows commandline:

    > set GIT_HASH=dev-build & set BUILD_TIME=dev-build
    

    or in windows powershell:

    > [Environment]::SetEnvironmentVariable("GIT_HASH", "dev-build") 
    > [Environment]::SetEnvironmentVariable("BUILD_TIME", "dev-build") 
    
  3. Build with:

    > cargo build
    

    or as release build

    > cargo build --release
    

Starting

The quest definitions loaded by the editor require some static definitions (e.g information about area hubs). These are stored in the "repo.quests" directory. The editor tries to load the definitions on startup from the "repo.quests" directory by default. You can provide another location the parameter --repo-dir where can be a relative or absolute path to the "repo.quests" content dir.

  cargo run

Example build debug-mode version and start with cargo (windows):

   > set GIT_HASH=dev-build & set BUILD_TIME=dev-build & cargo run

Options

> w3-quest-editor --help
w3 quest editor v0.1.12 (git:dev-build build:dev-build)
Usage: w3-quest-editor [options]

Options:
    -h, --help          print this help menu
    -d, --data-dir DIRECTORY
                        defines directory of quest definitions to edit
    -r, --repo-dir DIRECTORY
                        defines directory of repository for required quest
                        independent definitions. default is repo.quests/
    -v, --verbose       show debug messages in console
        --very-verbose  show more debug messages in console

Contributing

First: thank you for your interest! There are many ways to contribute. You can write bug reports, create pull requests to fix bugs or add new features or write documentation.

Please make sure your pull requests:

  • reference a ticket, if you want to add a new feature please make a ticket first and outline what you are trying to add
  • is formatted with rustfmt
  • compiles with the current master branch

If you have questions, you can find me on the nexusmods discord server in the #the-witcher-3 channel.