Skip to content

Commit 847ab02

Browse files
blaymsblayms
committed
Fix spelling in README.md
1 parent 5358a92 commit 847ab02

1 file changed

Lines changed: 19 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,43 @@
1-
21
# ModExtraAssets
32

4-
A tool made specificly to make a proccess of loading custom assets way easier
5-
Highly recommended to be used for Unity Engine BepInEx plugins
3+
A tool made specifically to make the process of loading custom assets much easier.
4+
Highly recommended for use with Unity Engine BepInEx plugins.
65

7-
- Supports \*.zip files (Stable)
8-
- Supports *.vfp files (Recently released and highly untested, but proven to be mainly working)
6+
- Supports \*.zip files (Stable.)
7+
- Supports \*.vfp files (Recently released and highly untested but has been proven to work for the most part.)
98

109
# Documentation
1110

12-
This tool has a documentation outside GitHub, check it [here](https://sites.google.com/view/mea-docs/main)
11+
This tool has documentation outside GitHub. Check it [here](https://sites.google.com/view/mea-docs/main).
1312

1413
# Supported file types
1514

16-
ModExtraAssets can recognize some file extension to create a specific asset of type
15+
ModExtraAssets can recognize some file extensions to create a specific type of asset.
1716

1817
| Extension | Zip Condition | Vfp Condition | Return type |
1918
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------ |
2019
| \*.png | None | None | UnityEngine.Texture2D |
21-
| \*.png | File name must contain !number at the end to define Sprite.pixelsPerUnit Value | File must contains a metadata pair **(Key: meaTexType, Value: sprite!{number to define Sprite.pixelsPerUnit Value})**. | UnityEngine.Sprite |
22-
| \*.png | File name must contain !c at the end to differentiate it from other \*.png files | File must contains a metadata pair **(Key: meaTexType, Value: cubemap)** | UnityEngine.Cubemap |
23-
| \*.png | File name must contain !sheet at the end to differentiate it from other \*.png files and also requires a [json file](https://sites.google.com/view/mea-docs/main/useful-information/loading-sprite-sheets) | File must contains a metadata pair **(Key: meaTexType, Value: sheet)**. Could use a separate json file or another metadata pair. Please [visit docs (step 5)](https://sites.google.com/view/mea-docs/main/useful-information/loading-sprite-sheets) for more information | Blayms.MEA.SpriteSheetMEA |
20+
| \*.png | File name must contain !number at the end to define Sprite.pixelsPerUnit value. | File must contain a metadata pair **(Key: meaTexType, Value: sprite!{number to define Sprite.pixelsPerUnit value})**. | UnityEngine.Sprite |
21+
| \*.png | File name must contain !c at the end to differentiate it from other \*.png files. | File must contain a metadata pair **(Key: meaTexType, Value: cubemap)**. | UnityEngine.Cubemap |
22+
| \*.png | File name must contain !sheet at the end to differentiate it from other \*.png files and must also include a [JSON file](https://sites.google.com/view/mea-docs/main/useful-information/loading-sprite-sheets). | File must contain a metadata pair **(Key: meaTexType, Value: sheet)**. It can use a separate JSON file or another metadata pair. Please [visit docs (step 5)](https://sites.google.com/view/mea-docs/main/useful-information/loading-sprite-sheets) for more information. | Blayms.MEA.SpriteSheetMEA |
2423
| \*.wav | None | None | UnityEngine.AudioClip |
2524
| \*.obj | None | None | UnityEngine.Mesh |
26-
| \*.json | [Referencing DLLs](https://sites.google.com/view/mea-docs/main/useful-information/json-tutorial) | [Referencing DLLs](https://sites.google.com/view/mea-docs/main/useful-information/json-tutorial) | Any _deserializable_ |
25+
| \*.json | [Referencing DLLs](https://sites.google.com/view/mea-docs/main/useful-information/json-tutorial) | [Referencing DLLs](https://sites.google.com/view/mea-docs/main/useful-information/json-tutorial) | Any deserializable type |
2726
| \*.txt or \*.text | None | None | System.String |
2827
| \*.dll | [\*.zip configuration](https://sites.google.com/view/mea-docs/main/useful-information/zip-configuration) | [\*.vfp configuration](https://sites.google.com/view/mea-docs/main/useful-information/vfp-configuration) | System.Reflection.Assembly |
2928

29+
# A couple of code snippets
3030

31-
# Couple of code snippets
32-
33-
Example: Loading database with using a zip file [Newtonsoft.Json](https://www.newtonsoft.com/json) library
31+
Example: Loading database using a zip file with [Newtonsoft.Json](https://www.newtonsoft.com/json) library
3432

3533
MEAZipLoadingProcedure proc = Blayms.MEA.ModExtraAssets.CreateLoadingProcedure<MEAZipLoadingProcedure>(@"D:\mycoolpluginfolder\myCoolZip.zip", this,
3634
(string json, Type type, object[] extraData) =>
3735
{
38-
return JsonConvert.DeserializeObject(json, type, (JsonSerializerSettings)extraData[0]);
39-
}, new object[]{MyCoolClass.GetJsonSerializerSettingsFor<LocalizationData>()});
36+
return JsonConvert.DeserializeObject(json, type, (JsonSerializerSettings)extraData[0]);
37+
}, new object[]{MyCoolClass.GetJsonSerializerSettingsFor<LocalizationData>()});
4038
proc.Initiate();
4139

42-
Example: Do stuff after all asset are finished to load from \*.zip
40+
Example: Perform actions after all assets have finished loading from a \*.zip file
4341

4442
// CREATE THE PROCEDURE
4543
MEAZipLoadingProcedure meaZipLoadingProcedure = ModExtraAssets.CreateLoadingProcedure<MEAZipLoadingProcedure>
@@ -48,19 +46,20 @@ Example: Do stuff after all asset are finished to load from \*.zip
4846
=> JsonConvert.DeserializeObject(json, type, Class.MyJsonSerializerSettings(type)), null);
4947

5048
meaZipLoadingProcedure.onLoadingResultDefined +=
51-
delegate (MEAZipLoadingProcedure.LoadingResult loadingResult) // SUB TO EVENT
49+
delegate (MEAZipLoadingProcedure.LoadingResult loadingResult) // Subscribe to the event
5250
{
5351
if(loadingResult == MEAZipLoadingProcedure.LoadingResult.Success)
5452
{
55-
//CODE
53+
// CODE
5654
}
5755
};
5856
meaZipLoadingProcedure.Initiate(); // START LOADING ASSETS
5957

6058
# Credits
6159

62-
This tool was made by [Blayms](https://blayms.github.io/about-me/) and uses some utils found online, such as:
60+
This tool was made by [Blayms](https://blayms.github.io/about-me/) and uses some utilities found online, such as:
6361

6462
- [ICSharpCode.SharpZipLib](https://github.com/icsharpcode/SharpZipLib)
6563
- [deadlyfingers/UnityWav](https://github.com/deadlyfingers/UnityWav)
6664
- [Dummiesman/ObjLoader](https://github.com/PhalanxHead/UnityRuntimeOBJLoaderDocs)
65+

0 commit comments

Comments
 (0)