royawesome/worldsmith

Open source Dota 2 Mod Editor

Worldsmith

Open source Dota 2 Mod Editor inspired by Warcraft 3's World Edit.

You can contact me on IRC at #dota2mods on irc.gamesurge.net.

Looking for builds? You can get the latest build here

Contributing

Like this project? Want to help? Here are a few ideas:

• If you can, please Donate to keep the project running.
• If you can program, I appreciate pull requests. Please see the pull request guidelines below.
• If you can help translate Worldsmith, please get in contact with me or submit a pull request.
• Tell the world about Worldsmith.

Credits

Current Team

• RoyAwesome
• SinZ
• Aderum
• penguinwizzard

Without a few people, this project would be much much harder. In no particular order:

• penguinwizzard for figuring out how to write maps.
• tet, Sir_Kane, and hex6 for finding the strings for most of the flags and enums.
• hex6 for doing the legwork for setting up translations.
• Quintinity for cleaning up the quality and doing incredibly helpful quality work.
• OrangeSodaSmurf for providing a coupon for a free domain name.

Translation credits

• Swedish - hex6

Compiling the Source

All major dependencies are included in the repository. You may have to update submodules if you have errors with KVLib and Graph.

Worldsmith also relies on some NuGet packages. If you are using Visual Studio 2012 or 2013, this will be automatically handled. If not, you need to install NuGet and restore the dependencies.

Worldsmith was created with Visual Studio 2015.

If you change any of the data schemas, be sure to run the ClassGen build target. This will update the data class definitions.

Pull Requests

I greatly appreciate pull requests, but I ask contributers to follow some guidelines.

• Worldsmith uses Microsoft's C# style guide.
• Please follow the general style of the rest of the code base.
• Use spaces, not tabs.
• Use Windows line endings.

worldsmith's Issues

Missing Schema Values 12/16/2014

• attach_hitloc (particle EffectAttachType)
• DOTA_UNIT_TARGET_OTHERS
• MODIFIER_STATE_DOMINATED

Object Viewer Context Menu

Right clicking on the object menu should give some context menu options.

• Open in Text Editor - Opens the selected object in the text editor. The code for this is written, it just needs to be hooked up to the context menu (DotaDataDocument.OpenTextEditor())
• Delete Object - If the object is not in the VPK, we should be able to delete it.
• Rename Object - not sure if this can be better done in the property view.

Lua enhancements

Integrating Lua tools with knowledge about the other components is a big step. This is a meta-issue, assign other issues as dependencies for this one for individual components to get Lua integration.

Some kind of notification when a project isn't loaded

Currently, if no addon is loaded, all you see is the Console window. There should be some kind of notification that you need to create a new addon or open one to begin.

Issue when reading DotaData

we should check whether the addon dictionary is exist or not, and let a reset of addon path and dota2 path then ask the user to set it again, or an error will occur like the picture below.
anyway, good job and carry on!

Sound Managment

Figure out what the sounds are, and use them for automatic suggestions in places where sounds are required.

Particle Helper

Particle helper that auto-suggests valid particles in places where they're required, checks to make sure any particles that you use are defined, and helps you copy particles from regular Dota to your addon directory.

Investigate rewriting the DOM to turn DotaObject types into thin wrappers around Key-Value trees

@Penguinwizzard mentioned doing this. Investigate it's viability and how much it would take to break them apart.

Asset Picking

For fields that need asset references (Model, sounds, icons), we need a dialog to select the asset in the project.

The data schema must be annotated with what asset type is required in that field.

Assets must be discovered and registered inside the Addon as well as the VPK.

A dialog must be created to list the assets of the proper type and select them.

Improve the Asset Loading Screen during initial load

Currently it just shows a loading bar and some text.

It should have a header image, some text describing the Worldsmith project, linking to the project page and displaying credits.

It could play a little bit of dota music when starting up (akin to how the Warcraft 3 editor played music when starting up), but that is purely optional.

Multiple VPK Support

Worldsmith can only open one VPK at a time. Dota has multiple VPKs that it draws from and worldsmith should be able to open and index all of them

Buttons in the Window menu item do not work

They should enable/disable the non-document panels, like Object View or Project View. They should be disabled when a project is not open.

AbilityActionCollection does not parse

After 616ed7a , the AbilityActionCollection does not parse. It needs to be turned into a Thin Wrapper around the Actions subkey and should return stuff out of it.

Text Editor: Key-Value syntax highlight

A syntax highligher for Key-Values should be written

Asset Loading Dialog has no taskbar icon

It should probably have the Worldsmith icon.

Allow organizing units into folders in the Object Browser

Should be able to create folders in the Object browser and move elements into them.

To store the folder structure, perhaps we should put a key in the Unit file for "wsFolder". Dota should ignore keys it has no idea about.

Load the language files for the addon and use them to translate unit names in the Unit Editor

Translate the data class name into a human readable name using the addon's Addon_English.txt (or whatever language is loaded).

Improve the AbilityActionEditor

Ohgod its so bad

RunScript Auto-script Linking, Lua function discovery

When adding a RunScript Action, we would normally want to quickly define the ScriptFile and Function and jump directly into the ScriptFile path, create a function and start coding it.

What could be added is:

• Singe click on the Function value lets you edit the name as usual, but also tries to:
  • If the function doesn't exist yet, gives an option to create a basic definition inside the lua ScriptFile
  • If the function already exists, it displays a hovering lua editor, positioned in the function:

• Double click on the Function name could do something similar:
  • If it doesn't exists, create it and enter the full editor (not hovering as scripts can be long and use helper functions internally), just open in another tab and position the cursor at the beginning of the function.
  • If it exists, open the full editor and position the cursor at the beginning of the functio
    • or if you want to go full awesome, the last recorded position where the user left editing it!

Ability Editor and Flag Dialog are broken

Ever since we moved to the docking panels, the custom editors for flags and ability action collections broke and don't pop up.

Library management

Set of libraries for auto-download through a package manager. Stuff like BMD's physics and timer, and statscollection.

Text Editor: Lua Syntax Highlighting

A Lua syntax highligher should be written for the text editor

Project File List needs to use the Document system

It currently just opens a text editor. It shouldn't do this. Go through the document system so we can track open/closed documents.

Documentation: Schema Files

A wiki page should be written describing how DotaObjectSchema classes are generated. It should explain the Key-Value fields, what they do, and how to generate the classes.

Document Management.

Many documents in a dota addon can be opened in different contexts.

Most .txt files can be opened as either a Plain Old Text file or as a Key-Value file (parse the KVs, display them in a grid view). Something should be created to allow editing in both contexts, then saving one editor saves the file and reloads both editors with the new data.

Certain files (npc_units_custom.txt, npc_items_custom.txt, and so on) should be opened with their own special editor for modifying properties. They are one big file to hold a ton of data objects, and it would be better to have them in their own tree view.

Ideally, we should disallow directly editing those special files, and instead route them into modifying each data object individually, then compile all of those objects into one big file when the project is saved. This would prevent having a potentially infinite number of editors trying to save and reparse these special files, and force users into the workflow of creating individual units/objects and editing them.

Documentation: Project Overview

A wiki page should be written that explains how the project is laid out and where to look for things.

No Icon for initial "Set Dota Directory" Window on first run

This is a relatively minor bug, but should get fixed for presentation reasons.

Document Modified Notification

If a document is modified by one editor, the changes need to be propagated to all open editors for that document.

For example, if you modify a property of a unit in the property editor, the text editor for that unit should be updated with the change.

Create Data Objects should have the datadriven base class

This is mostly @b2zeldafreak

• Data Driven unit base is 'npc_dota_creature'
• Ability is 'ability_datadriven'

These two items should be the first and most obvious option for those categories.

Project Viewer does not have an Icon

We do not have a good icon for this. It should be something related to files/folders but also dota related.

If someone is feeling clever, doing a 16x16 dota logo with a folder in the middle (instead of the division sign) might be funny/clever/good.

Non-empty new addon options

Similarly to VS, have a few options for new projects. For example, one could be barebones; another could be 'vanilla dota', which just has vanilla dota set up, for the addons that are slight gameplay modifications.

KeyValue folding isn't working

Due to an unknown reason, it is currently not allowing the user to fold on {} like

Improve the Object Property Editor

It's pretty fugly. That control could be improved to be less ugly.

This is probably a big project. There might be some 3rd party property editor controls that we could leverage for this

Some features that would be nice:

• Searching keys
• Flag editors
• Categories

Don't create multiple of the same editor

If an editor is requested (double clicking on an object) and it is already open, it should just bring that editor to focus, not create a new one.

Basic Dota Environment Simulation

This is kinda a big one. Integrate a bunch of parsers and a LuaVM, and have buttons to trigger events. Should handle the same way that Dota would (but without the same interface, and without automatically stepping forward in timesteps). Any system not simulated would have to be handled manually by the user.

Create Unit/Item/Ability buttons

The Dota Object Editor doesn't have buttons for creating new objects.

Basic Map Logic Handling

There are many cases in which developers will want to have calls from their map logic to various scripting functions. It would be helpful if WorldSmith would present a list of these to the user while coding relevant Lua code, so that it requires less back-and-forth checking.

Context menu for document tabs

Document tabs should have a context menu with a few options.

• Save (saves the current document)
• Save-All (saves all open documents)
• Close (closes editor)
• Close All (closes all editors)
• Close All to the Left/Right

Opening more than one project gives duplicate dockable forms

A solution would be to nuke the two forms before creating again, or to reset the Document rather than a new form

Proof


Improve the Open Addon dialog

Right now it's just a folder select. This should be more intuitive. List the addons probably.

In-Editor Console

A Console Panel should display console output of the program as well as take input for when we integrate a Lua VM into Worldsmith

Making a new addon creates it at [Drive]:\[AddonName]

It should create it at:
[DotaPath]\dota_ugc\game\dota_addons[AddonName]
[DotaPath]\dota_ugc\content\dota_addons[AddonName]

I couldnt find an issue related to this.

Saving Data Objects is broken

KVLib properly serializes the full KV tree, but certain keys should be excluded if they are default. This code is mostly working, it just needs to be tested and corrected.

Save Form Layout, Size, and Document Positions and restore them when the editor starts

Having to resize WS every time I open it is super annoying. Form size, position, and basic layout should be rememberd and stored for next time it opens. This includes window dock positions as well.

Trying to open a removed addon at start causes exception

If you remove a project that was loaded when you exited WorldSmith and then start WorldSmith it will error out on the function ProjectView.RecursivePopulateFromProject with DirectoryNotFoundException.

We need to handle removed/renamed directories when starting WorldSmith,

Create an Options Dialog and move the Theme dropdown into it

Themes are cute, but there should be an overall dialog for all Worldsmith settings and a simple way to add new saveable settings.

Documentation: Basic Usage

We need a wiki page on basic usage and how to use Worldsmith. Should cover Addon Creation/Loading, basic Unit creation, and an overview of the different panels.

* on Editor Tab when the document is modified

When a document is modified, all editors should have a * in the tab to indicate that that object or document has been modified and should be saved.

Performance Issue with Project View

Iterating through every file in the VPK takes a significant amount of time. We should either look into reducing this time or running the iteration/placing of tree nodes in a BackgroundWorker and not block the UI.

Investigate a better and more maintained Docking library

Digital Rune's docking library is no longer maintained. Do we want to live with any issues that come up (like not being able to design custom themes) or do we want to explore other options?

Here is a library that we could use: https://github.com/dockpanelsuite/dockpanelsuite