valence/extractor/README.md

# Valence Extractor

This is a Fabric mod for Minecraft that extracts data about different things in Minecraft, like blocks, packets, etc. All the extracted data is stored in the sibling `extracted` folder.

## How to use

Here's how to regenerate the contents of `extracted`.

From this directory, run the following

```sh
./gradlew runServer
```

This will run the extractor and immediately exit, outputting the files that are listed in the logs. 

Next, run `copy_extractor_output.sh`. This copies the files to `extracted` so that they can be comitted.

```sh
./copy_extractor_output.sh
```

## Contributing

Run `./gradlew genSources` to generate Minecraft Java source files for your IDE.
add readme for extractor (#90) 2022-09-27 19:22:28 -04:00			`# Valence Extractor`

			This is a Fabric mod for Minecraft that extracts data about different things in Minecraft, like blocks, packets, etc. All the extracted data is stored in the sibling `extracted` folder.

Update to 1.19.4 (#302) ## Description Closes #291 - Update extractors to support Minecraft 1.19.4 - Update code generators. - Changed generated entity component names to avoid name collisions. - Update `glam` version. - Added `Encode` and `Decode` for `glam` types in `valence_protocol`. - Fixed inconsistent packet names and assign packet IDs automatically. - Remove `ident` and rename `ident_str` to `ident`. - Rework registry codec configuration. Biomes and dimensions exist as entities.`BiomeRegistry` and `DimensionTypeRegistry` resources have been added. The vanilla registry codec is loaded at startup. ### Issues - Creating new instances has become more tedious than it should be. This will be addressed later. ## Test Plan Steps: 1. Boot up a vanilla server with online mode disabled. 2. Run the `packet_inspector`. 3. Connect to the vanilla server through the packet inspector to ensure all packets are updated correctly. 4. Close the vanilla server and try some valence examples. 2023-03-31 14:58:47 -07:00			`## How to use`
add readme for extractor (#90) 2022-09-27 19:22:28 -04:00
			Here's how to regenerate the contents of `extracted`.

			`From this directory, run the following`

			```sh
			`./gradlew runServer`
			```

Update to 1.19.4 (#302) ## Description Closes #291 - Update extractors to support Minecraft 1.19.4 - Update code generators. - Changed generated entity component names to avoid name collisions. - Update `glam` version. - Added `Encode` and `Decode` for `glam` types in `valence_protocol`. - Fixed inconsistent packet names and assign packet IDs automatically. - Remove `ident` and rename `ident_str` to `ident`. - Rework registry codec configuration. Biomes and dimensions exist as entities.`BiomeRegistry` and `DimensionTypeRegistry` resources have been added. The vanilla registry codec is loaded at startup. ### Issues - Creating new instances has become more tedious than it should be. This will be addressed later. ## Test Plan Steps: 1. Boot up a vanilla server with online mode disabled. 2. Run the `packet_inspector`. 3. Connect to the vanilla server through the packet inspector to ensure all packets are updated correctly. 4. Close the vanilla server and try some valence examples. 2023-03-31 14:58:47 -07:00			`This will run the extractor and immediately exit, outputting the files that are listed in the logs.`

			Next, run `copy_extractor_output.sh`. This copies the files to `extracted` so that they can be comitted.

			```sh
			`./copy_extractor_output.sh`
			```

			`## Contributing`

			Run `./gradlew genSources` to generate Minecraft Java source files for your IDE.