The Great Module Audit and Merge-athon v2.0!
See original GitHub issueEdit: More details added for maturity levels, rules for our Merge-athon added - win prizes!
With GSOC ending and us having merged a lot of fundamental / API breaking things lately I’d like for us to do a round of module testing to catch our breath and make sure all the things are working - or at least compiling and running 😃
The zip I prepared earlier for this September’s playtest is http://jenkins.terasology.org/job/DistroOmega/1056/artifact/distros/omega/build/distributions/TerasologyOmega.zip and can be used for testing the before-case as lots of modules will will have broken since, possibly subtly (most/all will compile, some/most will run, a few/some will work fine)
Read on for more details and join us on Discord: https://discord.gg/terasology
Maturity levels in summary:
- Compiles - the module builds! Ideally also in Jenkins, not just locally
- To validate Jenkins compare the latest build date at http://jenkins.terasology.org/view/Modules/ with the latest module change date in Git. If there are newer changes ask on Discord for somebody to run it after you’ve validated that it runs locally (plenty of long term contributors have build access, more can be added if asked for)
- Runs - you can run the game with the module active and not crash. Confirm via game logs that the module actually did activate
- Look for a log line like
13:06:22.486 [main] INFO o.t.e.m.loadProcesses.RegisterMods - Activating module: Health:0.1.0-SNAPSHOT
to confirm
- Look for a log line like
- Works - the main thing the module does appears to be working OK - could be a quick test to verify that you can get and place all blocks or something like that, with any that have obvious UIs able to open
search [module name]
in the game console will be your friend
- Polished! - not only does the stuff work, seemingly all of it is in good shape, yay! This’ll be fairly easy for smaller modules, but hard for bigger ones (like JoshariasSurvival)
- In modules with StructureTemplate prefabs be sure to validate that they appear to place intact without obvious errors. Look for ways to fix if not, for instance if some of the blocks are in a different module. See the ST readme for more details
I’ve only included the modules in the stable lineup for now but we might want to add a few more we want to focus attention on. For instance FlexibleMovement has been identified as high potential, but may not even compile just yet.
In some cases (like JS) it’ll be hard to determine which module should count as working or not, but … apply best judgement.
Good First Issue / Hacktoberfest
Testing modules and making small fixes is generally easy. You just need a workspace (see https://github.com/MovingBlocks/Terasology/wiki/Dev-Setup) then groovyw module recurse SomeModule
to get all the source for that target module and its dependencies. Run the game, make a new world, make sure the modules are selected. See if everything starts up OK - if so that’s two checkboxes already!
Study the module some to figure out what it is actually meant to do so you can look at checkbox 3 and 4. Some modules have wikis, or even test plans. You can use the search ModuleName
(with an actual module of course) in the in-game console (tilde
or F1
) to find all the assets and such in the module to then see what to try out.
For PRs (needed for Hactoberfest) you will actually need to find something broken and then fix it with a PR to the associated module repo 😃
Try to coordinate on our Discord just to avoid duplicate work and to ask questions. If you can’t check the boxes directly here or need a whole bunch checked then also ask on Discord. And have fun!
For making a good PR see the template that should populate when you open a PR and https://github.com/MovingBlocks/Terasology/wiki/How-to-Work-on-a-PR-Efficiently
Merge-athon v2.0
As an attempt to hurry along merging any outstanding work before checking the boxes below we will award $100 Amazon gift cards to the top 10 helpful contributors who put in work for testing and merging all the things. Note that this is also an experiment in gamifying contributions so expect the rules to change during the live period of October 5th-19th
Scoring points!
- 1 for each box checked on The Great Module Audit
- ??? for each PR merged (varies with complexity and whether you were first to review & test it as well)
- ??? for each PR reviewed/tested (same)
- ??? for each new detailed issue covering some outstanding problem (more points for more important)
- ??? for each issue analyzed and replicated with better details added (varies on complexity + worth of addition)
- ??? for each new PR that resolves some outstanding issue (not really meant for brand new functionality or anything other than code bugs)
We’ll keep a private leaderboard and may extend the contest (after guaranteeing the top 10 as of October 19th), increase the number of gift cards, or add value to those going to particularly helpful contributors 😃
To get your points please ask on Discord and link to your work. Please be patient as it may be a little while before everything gets processed and responded to, but we’ll get it!
The list!
AdditionalFruits
- Compiles
- Runs
- Works
- Polished!
AdditionalItemPipes
- Compiles
- Runs
- Works
- Polished!
AdditionalRails
- Compiles
- Runs
- Works
- Polished!
AdditionalVegetables
- Compiles
- Runs
- Works
- Polished!
AdditionalWorlds
- Compiles
- Runs
- Works
- Polished!
AdvancedRails
- Compiles
- Runs
- Works
- Polished!
AdventureAssets
- Compiles
- Runs
- Works
- Polished!
Alchemy
- Compiles - nope!
- Runs
- Works
- Polished!
AlchemyPlantGenerator
- Compiles
- Runs
- Works
- Polished!
AlterationEffects
- Compiles
- Runs
- Works
- Polished!
Anatomy
- Compiles
- Runs
- Works
- Polished!
AnotherWorld
- Compiles
- Runs
- Works
- Polished!
AnotherWorldPlants
- Compiles
- Runs
- Works
- Polished!
Apiculture
- Compiles
- Runs
- Works
- Polished!
BasicCrafting
- Compiles
- Runs
- Works
- Polished!
Behaviors
- Compiles
- Runs
- Works
- Polished!
BlockDetector
- Compiles
- Runs
- Works
- Polished!
BlockNetwork
- Compiles
- Runs
- Works
- Polished!
BlockPicker
- Compiles
- Runs
- Works
- Polished!
Books
- Compiles
- Runs
- Works
- Polished!
Breathing
- Compiles
- Runs
- Works
- Polished!
CakeLie
- Compiles
- Runs
- Works
- Polished!
Caves
- Compiles
- Runs
- Works
- Polished!
ChangingBlocks
- Compiles
- Runs
- Works
- Polished!
CheatsForAll
- Compiles
- Runs
- Works
- Polished!
ChiselBlocks
- Compiles
- Runs
- Works
- Polished!
ChrisVolume1OST
- Compiles
- Runs
- Works
- Polished!
ChrisVolume2OST
- Compiles
- Runs
- Works
- Polished!
Cities
- Compiles
- Runs
- Works
- Polished!
ClimateConditions
- Compiles
- Runs
- Works
- Polished!
Climbables
- Compiles
- Runs
- Works
- Polished!
CombatSystem
- Compiles
- Runs
- Works
- Polished!
CommonWorld
- Compiles
- Runs
- Works
- Polished!
Compass
- Compiles
- Runs
- Works
- Polished!
ComputerMonitors
- Compiles
- Runs
- Works
- Polished!
Cooking
- Compiles
- Runs
- Works
- Polished!
CopperAndBronze
- Compiles
- Runs
- Works
- Polished!
CoreAssets
- Compiles
- Runs
- Works
- Polished!
CoreBlocks
- Compiles
- Runs
- Works
- Polished!
CustomOreGen
- Compiles
- Runs
- Works
- Polished!
DamagingBlocks
- Compiles
- Runs
- Works
- Polished!
Dialogs
- Compiles
- Runs
- Works
- Polished!
Durability
- Compiles
- Runs
- Works
- Polished!
DynamicCities
- Compiles
- Runs
- Works
- Polished!
Economy
- Compiles
- Runs
- Works
- Polished!
EdibleFlora
- Compiles
- Runs
- Works
- Polished!
EdibleSubstance
- Compiles
- Runs
- Works
- Polished!
Equipment
- Compiles
- Runs
- Works
- Polished!
EquipmentSmithing
- Compiles
- Runs
- Works
- Polished!
EventualSkills
- Compiles
- Runs
- Works
- Polished!
Exoplanet
- Compiles
- Runs
- Works
- Polished!
Fences
- Compiles
- Runs
- Works
- Polished!
FlexiblePathfinding
- Compiles
- Runs
- Works
- Polished!
FlowingLiquids
- Compiles
- Runs
- Works
- Polished!
Fluid
- Compiles
- Runs
- Works
- Polished!
FluidComputerIntegration
- Compiles
- Runs
- Works
- Polished!
FunnyBlocks
- Compiles
- Runs
- Works
- Polished!
Genome
- Compiles
- Runs
- Works
- Polished!
GooeyDefence
- Compiles
- Runs
- Works
- Polished!
GooeysQuests
- Compiles
- Runs
- Works
- Polished!
GooKeeper
- Compiles
- Runs
- Works
- Polished!
GrowingFlora
- Compiles
- Runs
- Works
- Polished!
Health
- Compiles
- Runs
- Works
- Polished!
HjerlHede
- Compiles
- Runs
- Works
- Polished!
HumanoidCharacters
- Compiles
- Runs
- Works
- Polished!
Hunger
- Compiles
- Runs
- Works
- Polished!
Inferno
- Compiles
- Runs
- Works
- Polished!
InGameHelp
- Compiles
- Runs
- Works
- Polished!
InGameHelpAPI
- Compiles
- Runs
- Works
- Polished!
Inventory
- Compiles
- Runs
- Works
- Polished!
IRLCorp
- Compiles
- Runs
- Works
- Polished!
ItemPipes
- Compiles
- Runs
- Works
- Polished!
ItemRendering
- Compiles
- Runs
- Works
- Polished!
JoshariasSurvival
- Compiles
- Runs
- Works
- Polished!
Journal
- Compiles
- Runs
- Works
- Polished!
Kallisti
- Compiles
- Runs
- Works
- Polished!
KComputers
- Compiles
- Runs
- Works
- Polished!
Lakes
- Compiles
- Runs
- Works
- Polished!
LegacyMusic
- Compiles
- Runs
- Works
- Polished!
LightAndShadow
- Compiles
- Runs
- Works
- Polished!
LightAndShadowResources
- Compiles
- Runs
- Works
- Polished!
Lost
- Compiles
- Runs
- Works
- Polished!
Machines
- Compiles
- Runs
- Works
- Polished!
Malicious
- Compiles
- Runs
- Works
- Polished!
ManualLabor
- Compiles
- Runs
- Works
- Polished!
ManualLaborEventualSkills
- Compiles
- Runs
- Works
- Polished!
MarcinScIncubator
- Compiles
- Runs
- Works
- Polished!
MarkovChains
- Compiles
- Runs
- Works
- Polished!
MasterOfOreon
- Compiles
- Runs
- Works
- Polished!
MawGooey
- Compiles
- Runs
- Works
- Polished!
Maze
- Compiles
- Runs
- Works
- Polished!
MedievalCities
- Compiles
- Runs
- Works
- Polished!
MetalRenegades
- Compiles
- Runs
- Works
- Polished!
Minerals
- Compiles
- Runs
- Works
- Polished!
Minesweeper
- Compiles
- Runs
- Works
- Polished!
Minimap
- Compiles
- Runs
- Works
- Polished!
MobileBlocks
- Compiles
- Runs
- Works
- Polished!
ModularComputers
- Compiles
- Runs
- Works
- Polished!
ModuleTestingEnvironment
- Compiles
- Runs
- Works
- Polished!
MoreLights
- Compiles
- Runs
- Works
- Polished!
MultiBlock
- Compiles
- Runs
- Works
- Polished!
MusicDirector
- Compiles
- Runs
- Works
- Polished!
NameGenerator
- Compiles
- Runs
- Works
- Polished!
NeoTTA
- Compiles
- Runs
- Works
- Polished!
OreGeneration
- Compiles
- Runs
- Works
- Polished!
Oreons
- Compiles
- Runs
- Works
- Polished!
Pathfinding
- Compiles
- Runs
- Works
- Polished!
PhysicalStats
- Compiles
- Runs
- Works
- Polished!
PlantPack
- Compiles
- Runs
- Works
- Polished!
PolyWorld
- Compiles
- Runs
- Works
- Polished!
Portals
- Compiles
- Runs
- Works
- Polished!
PotentialEnergyDevices
- Compiles
- Runs
- Works
- Polished!
Potions
- Compiles
- Runs
- Works
- Polished!
Projectile
- Compiles
- Runs
- Works
- Polished!
QuestExamples
- Compiles
- Runs
- Works
- Polished!
Rails
- Compiles
- Runs
- Works
- Polished!
Sample
- Compiles
- Runs
- Works
- Polished!
Scenario
- Compiles
- Runs
- Works
- Polished!
Seasons
- Compiles
- Runs
- Works
- Polished!
SegmentedPaths
- Compiles
- Runs
- Works
- Polished!
Sensors
- Compiles
- Runs
- Works
- Polished!
ShatteredPlanes
- Compiles
- Runs
- Works
- Polished!
Signalling
- Compiles
- Runs
- Works
- Polished!
SimpleFarming
- Compiles
- Runs
- Works
- Polished!
SimpleLiquids (note: moved to our org archive, may need to reflect here and elsewhere)
- Compiles
- Runs
- Works
- Polished!
Smithing
- Compiles
- Runs
- Works
- Polished!
Soils
- Compiles
- Runs
- Works
- Polished!
SoundyGenetics
- Compiles
- Runs
- Works
- Polished!
Spawning
- Compiles
- Runs
- Works
- Polished!
StaticCities
- Compiles
- Runs
- Works
- Polished!
StoneCrafting
- Compiles
- Runs
- Works
- Polished!
StructuralResources
- Compiles
- Runs
- Works
- Polished!
StructureTemplates
- Compiles
- Runs
- Works
- Polished!
SubstanceMatters
- Compiles
- Runs
- Works
- Polished!
SurfaceFacets
- Compiles
- Runs
- Works
- Polished!
Tasks
- Compiles
- Runs
- Works
- Polished!
Thirst
- Compiles
- Runs
- Works
- Polished!
ThroughoutTheAges
- Compiles
- Runs
- Works
- Polished!
TutorialAssetSystem
- Compiles
- Runs
- Works
- Polished!
TutorialBehaviors
- Compiles
- Runs
- Works
- Polished!
TutorialDynamicCities
- Compiles
- Runs
- Works
- Polished!
TutorialNui
- Compiles
- Runs
- Works
- Polished!
TutorialSectors
- Compiles
- Runs
- Works
- Polished!
TutorialWorldGeneration
- Compiles
- Runs
- Works
- Polished!
Valentines
- Compiles
- Runs
- Works
- Polished!
WeatherManager
- Compiles
- Runs
- Works
- Polished!
WildAnimals
- Compiles
- Runs
- Works
- Polished!
WildAnimalsGenome
- Compiles
- Runs
- Works
- Polished!
WildAnimalsMadness
- Compiles
- Runs
- Works
- Polished!
WoodAndStone
- Compiles
- Runs
- Works
- Polished!
WoodAndStoneCraftingJournal
- Compiles
- Runs
- Works
- Polished!
WoodCrafting
- Compiles
- Runs
- Works
- Polished!
Workstation
- Compiles
- Runs
- Works
- Polished!
WorkstationCrafting
- Compiles
- Runs
- Works
- Polished!
WorkstationInGameHelp
- Compiles
- Runs
- Works
- Polished!
WorldlyTooltip
- Compiles
- Runs
- Works
- Polished!
WorldlyTooltipAPI
- Compiles
- Runs
- Works
- Polished!
Issue Analytics
- State:
- Created 4 years ago
- Comments:8 (4 by maintainers)
Top GitHub Comments
All of the pull requests for the CoreAssets & CoreBlocks refactor have been merged!
Here’s a list of compatibility PRs for #3704 in the various modules. They should all be ready for a quick review and merge by anyone who would like to give it a shot: