Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[gameobj] Migrate XML updates from ;xmlpatch

Open
  • Is something wrong?
#97 7 comments 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 1 day

@mrhoribu is already working on this.

Since Jun 1, 2022.

Assessment

This issue has not been assessed yet.

Description

game-obj-data

Migrate XML updates from ;xmlpatch

;xmlpatch was created a workaround for getting changes merged into the upstream gameobj-data.xml. Now that we own the gameobj-data.xml file published in the repo, we can create migrations for the published data and make the script obsolete. I am getting started on the work and wanted to have a discussion about some of the changes required so that we're all on the same page. There are two main types of XML updates in ;xmlpatch:

Phase 1: Updates to existing types

These are pretty straightforward and I've started creating migrations for these. I should have some PRs to send soon.

  • Handful of additions and exclusions to existing types
    • armor
    • clothing
    • jewelry
  • Creatures and gems from new areas (SoS, Reim)
  • Use names (e.g. "rotting fel trunk") instead of nouns for box type and allow optional shifting prefix for phased boxes.
Phase 2: New Type Categories

These are all new types that don't currently exist in gameobj-data.xml. I think that they are all worthwhile additions that make sense for us to merge upstream, but if anyone feels like adding these may cause issues, please let me know.

  • reim - creature and gem category. Plan to add as realm:reim
  • moonshard - Duskruin quest items. Propose folding these into the event:duskruin and quest types instead of creating a separate category just for moonshards.
  • duskruin - area category for gems. Adding as event:duskruin
  • pennant chase - Pennant Chase quest items to add as event:pennant chase
  • noncorporeal - creature category
  • companion - new NPC category for ranger companions
  • familiar - new NPC category for wizard familiars
  • phased - new type for phased (704) boxes
  • breakable - new type for breakable items

I would like to create the new types through migrations, but that requires us to add a command to the migration DSL for creating new tables.

Dominant language
Ruby
Stars
27
Forks
67
Avg merge
12h 8m
Merged PRs (30d)
45

Getting set up

We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elanthia-online/scripts

All issues in elanthia-online/scripts

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.