Giter Club home page Giter Club logo

vic3-mapdata-editor's Introduction

Vic3 mapdata editor

*Read this in other languages: English, 简体中文

A Brief Introduction

Vic3 mapdata editor is an open source province editor based off Jomini.

Abilities

  • ✅ Visualize and edit Vic3 states(Keeping track of region_state)
  • ✅ Visualize and edit Vic3 state resources、city provinces、population and buildings
  • ✅ Visualize and edit Vic3 strategy_region

TODO

  • A more intuitive way to display nations(Without using more files)
  • Optimize visualization performance,Fix CROS bug
  • Visualize and edit adjacencies
  • Real-time visualization and editing of city provinces
  • A live instance on the web that is created with docker
  • Refactor JavaScript to TypeScript?)
  • Good autocomplete
  • Good user and developer documentation
  • Scalable UI(I'm not joking,this is really difficult)
  • Update the map based on save files(So long! The main thing is I don't understand how the saves written!)
  • In summary, I welcome all suggestions for modifications

Quick Guide

By the new version, if you install vanilla game, you can just launch the ediotr without put anything!

If your game installation failed, please follow the guides below:

In data folder of the repo:

  • buildings: place all documents in game/common/history/buildings to this folder
  • outputs: remain it empty if you save nothing
  • pops: place all documents in game/common/history/pops to this folder
  • state_regions: place all documents in game/map_data/state_regions to this folder
  • strategic_regions: place all documents in game/common/history/strategic_regions to this folder
  • states: place all documents in game/common/history/states to this folder
  • adjacencies.csv: as the same name document in game/map_data
  • provinces.png: as the same name document in game/map_data
  • rivers.png: as the same name document in game/map_data

Double-click start.exe and launch the editor.

There are serval mode of the editor: prov,state,edit,strategy,and country

  • prov: Just for look the default map and generate a color which can not shown in the map
  • state: Click to select a state_region, and edit the property of this state_region
  • edit: Editing the history/state. Click to select a prov, ctrl+click to select multiple provs, shift + click to select all of the provs of the state_region which contains your selected prov, press the mouse left key and drag and release to select a series of provs in a rectangle selecting area,edit the input of state and country, press convert button to convert.
  • strategy: Click to select a state_region, ctrl+click to select multiple state_regions, edit the strategy_region, press convert button to convert.
  • terrain: Show the terrain if you put map_data/province_terrains.txt
  • country: Just for watch and it has the risk of crash

In your editing, the save button should be press to save the files. All of the save file would be in data/outputs If you select debug in the tray menu, in your next editing(fresh it or click open in the tray menu after you close the previous editor), the editor would read your previous saving as the inputs.

Finally you will get a series of document, you should place them in mod folder(where you create your mod!), and make them replace the vanilla files

in .metadata/metadata.json:

{
    "name": "Yourmod",
    "id": "your.mod",
    "version": "0.01",
    "supported_game_version": "",
    "short_description": "",
    "tags": ["funny modding"],
    "relationships": [],
    "game_custom_data": {
        "multiplayer_synchronized": true,
        "replace_paths": [
            "common/history/states",
            "common/history/pops",
            "common/history/buildings",
            "map_data/state_regions",
            "common/strategic_regions"
        ]
    }
}

In your mod folder there is only one file, they are:

  • common/history/states/00_states.txt
  • map_data/state_regions/01_state_regions.txt
  • common/strategic_regions/02_strategic_regions.txt
  • common/history/buildings/04_buildings.txt
  • common/history/pops/05_pops.txt

vic3-mapdata-editor's People

Contributors

jaykingamez avatar linnest2020 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

vic3-mapdata-editor's Issues

The editor can't read any existing files

It might be a bit hard explain, but the current issue I have encountered was that the editor keeps crashing, and doesn't seems to restart at the point where it crashes, even if I have already saved the edit before hand. Is there a way to make the editor directly load from the map of an existing mod, that would be significantly helpful.

不能导入任何文件

我尝试了很多方法,根本没法导入任何文件,包括editor自己生成的。
没法从mod导入。用调试模式也无法打开output的内容。

start.go编译错误

我看start.go文件中的systray包好像是改过的,请问下能提供一下你的systray包吗?

Use TypeScript instead of JavaScript

It will be pretty annoying to declare types for the various HTML elements, but it has to be done.

Still, if we do so, what bundler should we use rollup or webpack?

Request for editing generated_map_object_locators

In my community they request for gfx/map/map_object_data/generated_map_object_locators_{type}.txt for initiate the location of generated_map_object_locators. In-game editor, though much more accurated, but are too hard.

Bring back the old method of directly placing files

Conext

Our team is developing a total conversion mod featuring a completely new map, different from that of vanilla. We were using your program until v1.0.36 was released with the automatic game path detection feature.

Current Behavior

The program can only read files from vanilla, which makes making a map from scratch using the program practically impossible.

Expected Behavior

If relevant files are manually put in data, the program should use those files instead of the vanilla ones.

Possible Solution

Please bring back the old method of directly placing files in data as a possible alternative to the auto detection.

无法保存

点了保存,outputs文件夹里没有任何变化

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.