[Mod Utility] Entity Editor and Validation Tool (Fan made, Supports Rebellion)

By ZombiesRus5 on April 20, 2010 8:39:12 PM from

Sins of a Solar Empire Forums External Link

ZombiesRus5

Join Date 02/2009

+248

I have a set of eclipse and ant based tools for modding with Sins that others may find useful when validating or building their projects.

Project Home
Downloads (Current version 1.0.0, last stable version 0.9.0)
Wiki Syntax

Issues
FAQ
System Requirements
Version History

(New) Syntax Wiki - A syntaxual representation of almost all of the Sins editable files.

How To's:
How To Convert Reference Files
How To Install Eclipse
How To Setup Entity Validation Eclipse Plugin (Updated for new preference with v0.6)
How To Use Ant build.xml
How to Setup Subversion for Eclipse and code.google.com

(New) Video: How to setup and configure the Soase Eclipse Plugin

References:

Modding Tools (Weebly)

Mod Development with Eclipse (Forum link providing a general overview of Eclipse)

Eclipse download site (http://eclipse.org/downloads)

Tools Supported:

Entity Editor (Click me for cool stuff about visual Entity Validations)

Eclipse Editor builder/nature extension that provides visual feedback to the following validations.

Entity Definition View - Displays the syntax rules for the currently opened entity file.

Summary of validations currently supported:

Boolean: Validates boolean entries contain TRUE or FALSE only
Brush: Validates a referenced brush entry exists for the value entered
Conditional Validation: Allows conditional structures to follow based on a field value
Key word: Validates all entity file key words are spelled correctly
Quotes: Validates any values requiring qoutes have beginning and ending quotation marks
Integer: Validates integer entries contain digits
Decimal: Validates decimal entries contain ####.#####
Entity References: Validates a referenced entity file exists for the value entered
String Reference: Validates a referenced String entry exists for the value entered
Sound Reference: Validates a referenced Sound entry exists for the value entered
Enumeration Validation: Validates an entry confirms to an allowed set of values (i.e. buffInstantActionType)
Iteration Validation: Validates repeating elements are correct
Structure Validation: Validates entries appear in the correct order in the entity file (configurable to allow unordered structures)
Explosion Validation: Validates a referenced explosion entry exists for the value entered
Texture Validation: Validates a referenced texture exists for the value entered
Particle Validation: Validates a referenced effect exists for the value entered
Sounddata Validation: Validates sounddata files for correctness including referenced sound files
(NEW) GalaxyScenarioDef Validation: Validates galaxyScenarioDef files for correctness with 2 pass validations
StringInfo Validation: Validates English.str for correctness
Brushes Validation: Validates brushes files for correctness
Gameplay.constants: Validates the Gameplay.constant file for correctness
(NEW) Explosiondata Validation: Validates sounddata files for correctness including referenced sound files
(NEW) Galaxy Validation: Validates galaxy files for correctness and performs additional validations on referenced templates and design names.

Content Assistance: [ctrl]+[space bar] on keywords or constants and get suggested completions
Syntax Coloring: change syntax coloring of entity files to suit your preferences (defaults to all black currently)
Hover Help: hover over a keyword and get additional details about the value or structure
Quick link to wiki syntax

Manifest Generator
Collects entities from multiple source directories and builds the Entity Manifest File for Deployment.

Brush Generator

Takes a csv delimited template and generates a properly formatted brush file.

Sins Eclipse Editor used by:

I'd love to know if you use the Sins Eclipse Editor in your mod

more on previous reply...

Gameplay.constants:

<structure_reference name="ChanceToHitTargetType:TITAN" type="ChanceToHitTarget" version="Rebellion"/>

<structure_reference name="diplomaticPointsSpeedData-Slow" type="DiplomaticPointsSpeedData" version="DiplomacyOnly"/>
<structure_reference name="diplomaticPointsSpeedData-Normal" type="DiplomaticPointsSpeedData" version="DiplomacyOnly"/>
<structure_reference name="diplomaticPointsSpeedData-Fast" type="DiplomaticPointsSpeedData" version="DiplomacyOnly"/>
<structure_reference name="diplomaticPointsSpeedData-Faster" type="DiplomaticPointsSpeedData" version="DiplomacyOnly"/>
<structure_reference name="victorySpeedData-Slow" type="DiplomaticPointsSpeedData" version="Rebellion"/>
<structure_reference name="victorySpeedData-Normal" type="DiplomaticPointsSpeedData" version="Rebellion"/>
<structure_reference name="victorySpeedData-Fast" type="DiplomaticPointsSpeedData" version="Rebellion"/>
<structure_reference name="victorySpeedData-Faster" type="DiplomaticPointsSpeedData" version="Rebellion"/>

<iterative_field name="FactionCount" version="Rebellion">
<field required="false" name="FactionName" validation="StringInfo"/>
</iterative_field>

more coming...

Successfully updated karma reason!

more on previous...

useCostType:

<condition>
<value version="Rebellion">ResourcesAndMustHaveTitan</value>
<value>Resources</value>
<structure_reference name="resourceCost" type="Cost"/>
<structure_reference name="cooldownTime" type="GenericLevel"/>
<field name="orderAcknowledgementType" type="orderAcknowledgementType" version="Entrenchment"/>
</condition>
<condition><value>HullAndAntimatter</value>
<structure_reference name="hullCost" type="GenericLevel"/>
<structure_reference name="antiMatterCost" type="GenericLevel"/>
<structure_reference name="cooldownTime" type="GenericLevel"/>
<field name="orderAcknowledgementType" type="orderAcknowledgementType" version="Entrenchment"/>
</condition>

Successfully updated karma reason!

Wiki's been updated too for the current Rebellion content (See link in OP).

Successfully updated karma reason!

Quoting ZombiesRus5,

reply 182

Wiki's been updated too for the current Rebellion content (See link in OP).

Looks like no changes with the release of Rebellion so I've uploaded the latest version of the plugin. Install it the same way as before.

This plugin will support the previous versions of sins and rebellion, BUT not in the same workspace. You will need to create another workspace for Rebellion and setup the SOASE preferences for that workspace similar to below.

Successfully updated karma reason!

I got a couple of issue reports today which is nice.

I think they are related with the Strict Version Validation defaulting to Diplomacy. If your using the tool for Rebellion, make sure to go into Windows/Preferences/Sins Preferences and select the Rebellion Strict Version Validation.

Successfully updated karma reason!

Thanks for the quick reply;

I was the one that posted those reports; I did check that i was in fact using the Rebellion validation and I was. Both issues still occur with strict validation set to Rebellion; also note that at least the issue with targetfilter in buffs is not related to Rebellion, since this existed in pre-Rebellion files as well.

edit:

I just checked the xml definitions and they do seem to contain both the targetfilter and the POINTDEFENSELASER;

the targetfilter issue might be that the targetfilter item is not available for all possible buffs that can use it; I'm using it on instantaction buff type: ApplyBuffToLocalOrbitBodyWithTravel; so I suspect targetfilter may be used in more situations than you anticipated (the (dev) game seems to handle it just fine)

I also checked the .pref file and the strictVersion string was Rebellion, so I believe the problem may be that the conditional items are not being handled properly;

edit 2:

I just realized a possible cause for the POINTDEFENSELASER: I use it in linkedWeaponClass as part of a researchModifier; you may have missed those. - just confirmed that the xml is missing the rebellion weapon entries.

Successfully updated karma reason!

Quoting TMPhoenix,

reply 185

the targetfilter issue might be that the targetfilter item is not available for all possible buffs that can use it; I'm using it on instantaction buff type: ApplyBuffToLocalOrbitBodyWithTravel; so I suspect targetfilter may be used in more situations than you anticipated (the (dev) game seems to handle it just fine)

Can you post your example here? This is only included because Ironclad said it existed, though no actual entity file exists that uses it currently in the core game.

Quoting TMPhoenix,

reply 185

Fixed internally. I validated against the Rebellion source which didn't include these in any research modifiers. Though this may be a mistake with some of the pacts.

Successfully updated karma reason!

Well, here's an example of the targetfilter usage:

TXT
entityType "Buff"
onReapplyDuplicateType "PrioritizeOldBuffs"
buffStackingLimitType "ForAllPlayers"
stackingLimit 1
allowFirstSpawnerToStack FALSE
buffExclusivityForAIType "ExclusiveForAllPlayers"
isInterruptable FALSE
isChannelling FALSE
numInstantActions 1
instantAction
   buffInstantActionType "ApplyBuffToLocalOrbitBodyWithTravel"
   instantActionTriggerType "OnHyperspaceExit"
   buffType "BuffInherentPhaseGate"
   targetFilter
       numOwnerships 3
       ownership "Friendly"
       ownership "Enemy"
       ownership "NoOwner"
       numObjects 2
       object "Planet"
       object "Star"
       numSpaces 1
       space "Normal"
       numConstraints 0
   travelSpeed 1000.000000
   hasWeaponEffects TRUE
   weaponEffectOriginType "Targetter"
   weaponEffectAttachInfo
       attachType "Aura"
   weaponEffectImpactOffsetType "RandomMesh"
   canWeaponEffectHitHull TRUE
   canWeaponEffectHitShields TRUE
   weaponEffectsDef
       weaponType "Projectile"
       burstCount 1
       burstDelay 1.000000
       fireDelay 0.000000
       muzzleEffectName ""
       muzzleSoundMinRespawnTime 0.100000
       muzzleSounds
           soundCount 1
           sound ""
       hitEffectName ""
       hitHullEffectSounds
           soundCount 1
           sound ""
       hitShieldsEffectSounds
           soundCount 1
           sound ""
       projectileTravelEffectName ""
numPeriodicActions 0
numOverTimeActions 0
numEntityModifiers 0
numEntityBoolModifiers 0
numFinishConditions 0

Successfully updated karma reason!

Quoting TMPhoenix,

reply 187

Well, here's an example of the targetfilter usage:

Thanks, I uploaded a new version that addresses this gap as well as the new weapon class types used in research subjects.

Successfully updated karma reason!

Great,

it's working as expected now; thanks.

Successfully updated karma reason!

I do not know if this has already been reported but I'm trying to update my mod of diplomacy to rebellion and unless I am mistaken there is a new line added at the end of the research that the validator does not report:

uniqueOverlayBrush ""

Thanks for your wonderful tool and sorry for my english

Successfully updated karma reason!

Quoting dondurito,

reply 190

Ah yes, thanks for pointing this out. The tool indeed did not care because it was the last line of the file and it stopped validating at artifactPicture. Hence I did not see any issues with validating against the rebellion reference files.

I'll fix this with my next update.

Successfully updated karma reason!

Quoting ZombiesRus5,

reply 183

Looks like no changes with the release of Rebellion so I've uploaded the latest version of the plugin. Install it the same way as before.

This plugin will support the previous versions of sins and rebellion, BUT not in the same workspace. You will need to create another workspace for Rebellion and setup the SOASE preferences for that workspace similar to below.

Unless I missed it you might want to add this to your wiki instillation page.

Successfully updated karma reason!

Quoting GoaFan77,

reply 192

Quoting ZombiesRus5, reply 183Looks like no changes with the release of Rebellion so I've uploaded the latest version of the plugin. Install it the same way as before.

This plugin will support the previous versions of sins and rebellion, BUT not in the same workspace. You will need to create another workspace for Rebellion and setup the SOASE preferences for that workspace similar to below.

Unless I missed it you might want to add this to your wiki instillation page.

Thanks, I added that portion to the plugin setup.

Successfully updated karma reason!

This is truly an awesome thread...and sticky too.

Successfully updated karma reason!

Quoting Sinperium,

reply 194

This is truly an awesome thread...and sticky too.

Schwaa! When did this get stickied? Does that mean I get to stop updating it like the rest of the stickies?

Successfully updated karma reason!

N0--now you are subject to excessive whining and trolling when you don't update.

En joy.

Successfully updated karma reason!

Awesome! Did you do this plugin all by yourself? Also I'm quite impressed that you force people to work with Eclipse (and thus download the Java JDK/JRE) - it's highly useful Do you program in Java as well?

Successfully updated karma reason!

Quoting KhanAndSteak,

reply 197

Awesome!

Thank you!

Quoting KhanAndSteak,

reply 197

Did you do this plugin all by yourself?

Yes, it is was designed and developed soley by myself. It started in concept as a batch mod validator, but I soon realized after I had a working prototype created that I could potentially fit it as an Eclipse plugin. After some light researching on how to make Eclipse plugins I set about adding in the hooks to my mod validation tool. Even though I didn't accomplish all the goals I had set out for the Eclipse plugin, all in all it was a fairly satisfying experience.

Quoting KhanAndSteak,

reply 197

Also I'm quite impressed that you force people to work with Eclipse (and thus download the Java JDK/JRE)

I consider this the entry price and gateway to using the plugin. Basically if you can't download, extract Eclipse and the Java JDK then this tool is most likely above your head to use.

This tool is probably not for the notepad tinkerers, though if they are competent the content assistance and instant feedback of syntax errors can save a whole lot of hours in debugging. Also the quick openining of referenced entities is a godsend too (i.e. open a capital ship entity, highlight an ability->right click->open entity, and so on through the buffs). Add in the search capabilities of Eclipse, support for SVN, ... I could go on.

Quoting KhanAndSteak,

reply 197

Do you program in Java as well?

Yes, I've been coding in Java for a very long time now.

Successfully updated karma reason!

So are we going to be able to download 2.0.8 anytime soon? The version history says you had an update on June 28th but the latest download is from the 18th.

Successfully updated karma reason!

Quoting GoaFan77,

reply 199

So are we going to be able to download 2.0.8 anytime soon? The version history says you had an update on June 28th but the latest download is from the 18th.

I've uploaded 2.0.8 today. Thanks for reminding me.

6/28/2012 v2.0.8
# Defect: Changed RequiredFactionNameID from Any to StringInfo
# Defect: Added Invalid to WeaponClassType
# Enhancement: weaponClassForWeaponPassive now references global WeaponClassType
# Defect: PirateStrengthAgainstYouAdjustment changed to NotDiplomacyOrRebellion
# Enhancement: Added new version policy NotDiplomacyOrRebellion
# Defect: Added xpModifier to star base upgrade

Successfully updated karma reason!

Quoting KhanAndSteak,

reply 197

So, I've been meaning to look at some metrics on this tool.

Total Lines of Code: 5380

Soase Validation Logic: 2414 lines
Eclipse Plugin: 2479 lines
Soase XML Definitions: 5759 (all time consumingly hand edited)
Soase Wiki: 21588 lines (Generated from xml's)

Successfully updated karma reason!

Welcome Guest! Please take the time to register with us.
There are many great features available to you once you register, including:

Richer content, access to many features that are disabled for guests like commenting on the forums.
Access to a great community, with a massive database of many, many areas of interest.
Access to contests & subscription offers like exclusive emails.
It's simple, and FREE!

View all recent posts

Mark all posts as read • Delete cookies created by the forum • Return to Top

Stardock Forums v1.0.0.0 #108436 walnut3 Server Load Time: 00:00:00.0002047 Page Render Time: