zzzz465 / rwxml-language-server

autocomplete and debug your RimWorld XML

RWXML Language Server

provides various IDE functionalities, as VSCode Extension

Install (if you're using vscode first time?)

Check how-to

FAQ

Check FAQ

features

• Custom syntax highlighting
• Basic completion snippets.
• Real time code analysis.
• Code Completion.
• Go to definition, Go to Reference support.
• Find all symbol references.
• find parent / childrenss
• Symbol rename command.
• Inheritance Attribute suggestion
• AlienRace support
• incremental update & validation
• Texture preview
• Texture path suggestion
• patch operation snippets
• Cache DLL extracted data

Commands

RWXML: Clear DLL Cache

deletes all DLL extracted cache.

RWXML: Open Cache Directory

opens your cache directory.

Install

VSCode Marketplace (Click)

Configuration

configures RWXML Language Server.

{
  "rwxml.paths.rimWorld": "C:\\...\\common\\RimWorld", // RimWorld/ Directory path.

  // overrides default path / assumed path from rimWorld
  "rwxml.paths.rimWorldData": "C:\\...\\RimWorld\\Data",
  "rwxml.paths.rimWorldManaged": "C:\\...\\RimWorld\\RimWorldWin64_Data\\Managed",
  "rwxml.paths.localMods": "C:\\...\\RimWorld\\Mods",
  "rwxml.paths.workshopMods": "C:\\...\\workshop\\contents\\294100",
  "rwxml.paths.externalMods": [
    "<other-mods-directory-1>",
    "<other-mods-directory-2>",
    // and so on...
  ],

  
  "rwxml.logs.level": "info", // set log level, "info", "warn", "error", "debug", "silly"

  "rwxml.codeHighlighting.enabled": true, // manages code highlighting. fine-grained control is not implemented yet
  
  "rwxml.diagnostics.enabled": true, // manages code diagnostics.
}

Default Paths

this extension requires RimWorld DLL, RimWorld Core to operate. it scans Workshop/Local Mod Directory to support external mods.

the path for these resources are below:

RimWorld DLL

• windows: C:\Program files (x86)\Steam\steamapps\common\rimworld\RimWorldWin64_Data\Managed
• darwin(macos): Library/Application Support/Steam/steamapps/common/RimWorld/RimWorldMac.app/Contents/Resources/Data/Managed

RimWorld Core

• windows: C:\\Program Files (x86)\\Steam\\steamapps\\common\\RimWorld\\Data
• darwin(macos): Library/Application Support/Steam/Steamapps/common/RimWorld/RimWorldMac.app/Data

Local Mod Directory

• windows: C:\\Program Files (x86)\\Steam\\steamapps\\common\\RimWorld\\Mods
• darwin(macos): Library/Application Support/Steam/Steamapps/common/RimWorld/RimWorldMac.app/Mods

Workshop Directory

• windows: C:\\Program Files (x86)\\Steam\\steamapps\\workshop\\content\\294100
• darwin(macos): Library/Application Support/Steam/Steamapps/workshop/content/294100

Setup devlopment environment

1. clone repository locally

#!/bin/bash
git clone https://github.com/zzzz465/rwxml-language-server

2. install project

#!/bin/bash
# cwd: repository root
pnpm install

3. build project

#!/bin/bash
# cwd: repository root
pnpm run watch # this will build project and watch project changes

4. open /vsc-extension with VSCode, and launch Launch Client

rwxml-language-server's Issues

refactor client-side codes to use tsyringe (DI)

add tag value suggestions

show value type hints

rust-lsp like 50% opaque type hint

Can't find or install this extension

Is it Windows-only? Is Linux planned to be supported?

def inside list node not referenced correctly

Extension load error "cannot find type Def in typeInfoMap"

Hey,
no matter what I'm trying, I can't seem to get your installation to work.

I already moved Rimworld to the default install path to prevent problems that I've read about here, I entered all paths in the extension settings manually.

Now when my newly created nearly empty mod folder, the extension doesn't load up. Extension Output log shows:

current log level: debug
hello world! initializing @rwxml-language-server/language-server ...
initialization completed!
[warn] [f] [default] cannot find type Def in typeInfoMap. something isn't right.
[info] [r] [default] [15982c8c-ac06-4486-a584-f4d8be084e59] reloading project... reason: project initialize
[info] [r] [default] [15982c8c-ac06-4486-a584-f4d8be084e59] loading project resources...
[info] [r] [default] [15982c8c-ac06-4486-a584-f4d8be084e59] clear project...
[info] [r] [default] [15982c8c-ac06-4486-a584-f4d8be084e59] project cleared.
[info] [r] [default] [15982c8c-ac06-4486-a584-f4d8be084e59] project evaluated.

The extension is enabled, but doesn't show any runtime info, like other extension would do when they are loaded:

This is a pretty fresh install of Visual Code.

I love the idea of your extensions, and would be really happy if I could get this to work.

EDIT: I also tried opening the Rimworld folder itself, and some workshop mod folders, always the same errors.
I tried to dive into the code to see which def it tried to load, but it got a bit confusing. Are you loading DLLs manually there to register type definitions?

PatchOperation suggestions

formatting broken when commenting

fix tag completion not invoked on typing "<"

expected

actual

extract TypeInfo from workshop/local mods dynamically

support other mods dynamically

PN_FieldMedicModule 's reference is not found

add code snippets

No "Go to definition" (F12) jump on some references, eg ParentName tags

Creating it's own issue based on my observation in #119.

The ParentName tag does have a popup of the parent definition, but F12/Go to definition does not work there. Works in other popup/underlined places, like inside researchPrerequisites.

some nodes are not registered as linkable. it is not intended and needs to be fix.

def not suggested when no text content exists

codeLens: add referenced-by

delete circular dependency

rwxml-language-server/language-server/src/typeInfoMapProvider.ts

Lines 48 to 50 in f74bcaf

	private getTargetDLLUris(): string[] {
	return [...this.project.resourceStore.dllFiles.values()]
	}

rwxml-language-server/language-server/src/typeInfoMapProvider.ts

Line 23 in f74bcaf

@inject(delay(() => Project)) private readonly project: Project,

Usage without a Rimworld install?

Hey, I really like this tool, it looks super useful and I can't wait to try it out. I was wondering though if you ever considered adding functionality for it without a Rimworld install present. That way someone could mod in a lightweight environment like GitHub Codespaces without needing to have Rimworld installed on the system they're modding on. Obviously it probably wouldn't be able to do reflection on modded defs and such, but it could probably at least support vanilla defs.

improve logging system

1.3 update and Ideology support

As 1.3 was released with the Ideology DLC, I'd love to see support for both of these.

find project root by tracing up directories

extension not working when loadfolders.xml not exists

#119 (comment)

codeCompletion throws error "'className' of undefined"

refactor arguments of all event passing

refactor to
type Callback<T> = (caller: T, args: ...unknown[]) => Promise<unknown> | unknown

https://docs.microsoft.com/ko-kr/dotnet/csharp/event-pattern

codeLens deReferencing not working correctly

support for workspace

Linux, OS X Support

move cursor to inside contentRange after selecting suggestion

root resources not included if there's no `LoadFolders.xml`

#62 (comment)

plain texts not deleted when completing xml node

open reference dependency as read-only

Feature Request: Support of xml patch files

I know this might ask for a lot, but I am just throwing this idea in.

A lot of modding is based on patching existing xml defs, either from vanilla things or other mods. You write all those complicated patch statements with inserted references, names etc.
How cool would it be if a few of the features provided with your extension would work there?

I've seen you have "patch operation snippets" already on your planned features list. But having similar highlighting to the normal defs inside patch statements would be amazing. Sometimes you add whole xml blocks similar to xml defs where you could jump to requirements, materials, etc. Lots of mods add full ThingDefs based on mod conditional checks or similar.
On the patch conditions you are often referencing names, types or classes, which could have a "Go to definition" jumper if they are known.

Some examples:



(and I guess a lot more I can't think of right now)

Don't know if this is feasible, as this sounds really difficult, based on the XML being less logically structured than normal defs, but still throwing in the idea here.

allow custom local/workshop directory

Class suggests wrong values

tag completion not working when no "<" exists before cursor

extension crashs when rwxml.paths has invalid path

Codelens doesn't work on some references, eg abstract Thing definitions

Creating it's own issue based on my observation in #119.

My own abstract def has no quick info line above. Should show that it is referenced once. Checking other mods that work as well none of the abstract defs have that line above.
Go to references on the abstract def doesn't work

quick info is called "CodeLens". anyway, the reason why it's broken is a bit complex. there's two refernce types, 1. <defName>, 2. Name attribute. language server manages both types on resolving, but some features supports only one. that's why it doesn't pop up quick info.

you can see codelens code here as you can see, it checks <defName> value to determine whether to display codelens or not.

it is not a intended feature and needs to be fix.

dependency mods not resolved

PatchOperation simulation

kind of long-term

validation

long-term project

field name is completed instead of value

add refactor: rename defName

problem with anonymous, nested class extraction

How to set up 1.3 Insider version.

Hello! Thank you for making this tool. I found it very useful in the past.

I was hoping for a quick guide to setting up the new Insider version. I have installed it in VSCode but it does not seem to do anything. More specifically, it does not seem to recognize my custom def types or fields.
I understand that it no longer uses the config file (?)
Any help getting it to work would be appreciated.

I would like to help test and give feedback.
Thank you.

fix about is not listening changes

Paths: Workshop Mods settings is ignored

the setting of Paths: Workshop Mods is ignored, and it will always use the standard default path. as shown here:

failed request not printing stacktrace

ignore or re-order suggestions when other completion exists

tag name is completed but not making full valid node

Codelens shows up multiple times for definitions in some files

Creating it's own issue based on my observation in #119.

I opened a few workshop mods that I downloaded to test the features of this extension, and to dive a bit deeper into some of their code.
For a few, the Codelens info on the definitions showed up four times, not the usual 1 time which I saw in most other places.
I guess this is not intended?

I can provide the link to the workshop mod from the screenshot: Door Mat
I can also post the files or more info if you need it.

show warning "same load file path will conflict"

림월드는 가상의 폴더에 파일을 로드하는데, 이 때 경로가 겹치는 파일이 있으면 merge 되지 않고, 대신 override 를 하게 됨.
따라서 한 쪽이 날라가는 일이 발생함