Skip to content

Commit

Permalink
Updating Docs (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholas-maltbie authored Jan 7, 2023
1 parent bcd2440 commit e8d65a0
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 12 deletions.
13 changes: 13 additions & 0 deletions Documentation/manual/test-design.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Test Design

<!-- markdownlint-disable MD013 -->
<!-- markdownlint-disable MD033 -->
<!-- Disable line length lint rule for portion of embed -->
<div class="videoWrapper">
<iframe
src="https://www.youtube.com/embed/3No2mpbHJrI"
title="Why Test Games"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen></iframe>
</div>
<!-- markdownlint-enable MD013 -->

The OpenKCC project is a library intended for a variety of use cases.
To manage new code being added to the project and ensure it does not break
existing features, there are some tests added to the project.
Expand Down
2 changes: 1 addition & 1 deletion Packages/com.nickmaltbie.openkcc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ To use the latest release, simply reference:
git+https://github.com/nicholas-maltbie/openkcc.git#release/latest
```

For a full list of all tags, check the [OpenKCC Tags](https://github.com/nicholas-maltbie/ScreenManager/tags)
For a full list of all tags, check the [OpenKCC Tags](https://github.com/nicholas-maltbie/OpenKCC/tags)
list on github. I will usually associated a tag with each release of the project.

_Note_: before I started using the package format for the project, I manually
Expand Down
2 changes: 1 addition & 1 deletion Packages/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
}
],
"dependencies": {
"com.community.netcode.transport.websocket": "git+https://github.com/nicholas-maltbie/multiplayer-community-contributions?path=/Transports/com.community.netcode.transport.websocket#webgl-patch",
"com.community.netcode.transport.websocket": "git+https://github.com/Unity-Technologies/multiplayer-community-contributions?path=/Transports/com.community.netcode.transport.websocket#c7246c713392424c1388fd516f2c6a1debaea14d",
"com.nickmaltbie.recolorshaderunity": "1.0.0",
"com.nickmaltbie.screenmanager": "3.1.0",
"com.nickmaltbie.statemachineunity": "1.1.4",
Expand Down
4 changes: 2 additions & 2 deletions Packages/packages-lock.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"dependencies": {
"com.community.netcode.transport.websocket": {
"version": "git+https://github.com/nicholas-maltbie/multiplayer-community-contributions?path=/Transports/com.community.netcode.transport.websocket#webgl-patch",
"version": "git+https://github.com/Unity-Technologies/multiplayer-community-contributions?path=/Transports/com.community.netcode.transport.websocket#c7246c713392424c1388fd516f2c6a1debaea14d",
"depth": 0,
"source": "git",
"dependencies": {},
"hash": "16e5c169f16d618bfbbe25525bacc4107e55b318"
"hash": "c7246c713392424c1388fd516f2c6a1debaea14d"
},
"com.nickmaltbie.networkstatemachineunity": {
"version": "1.0.0",
Expand Down
24 changes: 19 additions & 5 deletions ProjectSettings/EditorSettings.asset
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,41 @@
EditorSettings:
m_ObjectHideFlags: 0
serializedVersion: 11
m_ExternalVersionControlSupport: Visible Meta Files
m_SerializationMode: 2
m_LineEndingsForNewScripts: 0
m_DefaultBehaviorMode: 0
m_PrefabRegularEnvironment: {fileID: 0}
m_PrefabUIEnvironment: {fileID: 0}
m_SpritePackerMode: 0
m_SpritePackerPaddingPower: 1
m_Bc7TextureCompressor: 0
m_EtcTextureCompressorBehavior: 1
m_EtcTextureFastCompressor: 1
m_EtcTextureNormalCompressor: 2
m_EtcTextureBestCompressor: 4
m_ProjectGenerationIncludedExtensions: txt;xml;fnt;cd;asmdef;rsp;asmref
m_ProjectGenerationRootNamespace:
m_CollabEditorSettings:
inProgressEnabled: 1
m_EnableTextureStreamingInEditMode: 1
m_EnableTextureStreamingInPlayMode: 1
m_AsyncShaderCompilation: 1
m_CachingShaderPreprocessor: 1
m_PrefabModeAllowAutoSave: 1
m_EnterPlayModeOptionsEnabled: 0
m_EnterPlayModeOptions: 3
m_ShowLightmapResolutionOverlay: 1
m_GameObjectNamingDigits: 1
m_GameObjectNamingScheme: 0
m_AssetNamingUsesSpace: 1
m_UseLegacyProbeSampleCount: 0
m_SerializeInlineMappingsOnOneLine: 1
m_SerializeInlineMappingsOnOneLine: 1
m_DisableCookiesInLightmapper: 0
m_AssetPipelineMode: 1
m_RefreshImportMode: 0
m_CacheServerMode: 0
m_CacheServerEndpoint:
m_CacheServerNamespacePrefix: default
m_CacheServerEnableDownload: 1
m_CacheServerEnableUpload: 1
m_CacheServerEnableAuth: 0
m_CacheServerEnableTls: 0
m_CacheServerValidationMode: 2
m_CacheServerDownloadBatchSize: 128
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ To use the latest release, simply reference:
git+https://github.com/nicholas-maltbie/openkcc.git#release/latest
```

For a full list of all tags, check the [OpenKCC Tags](https://github.com/nicholas-maltbie/ScreenManager/tags)
For a full list of all tags, check the [OpenKCC Tags](https://github.com/nicholas-maltbie/OpenKCC/tags)
list on github. I will usually associated a tag with each release of the project.

_Note_: before I started using the package format for the project, I manually
Expand Down Expand Up @@ -204,14 +204,15 @@ As these videos are created they will be listed here:
* [Projection Based Movement of KCC](https://youtu.be/s-99Z_W8bcQ)
* [How the KCC Manages Jumping](https://youtu.be/CGsDdBZa5EM)
* [Camera controller and Dither Shader](https://youtu.be/Zw6qvOOHGC4)
* \[Planned\] Character Controller Case Study and Requirements Engineering
* [Why Test Games](https://youtu.be/3No2mpbHJrI)

## Development

If you want to help with the project, feel free to make some
changes and submit a PR to the repo.

This project is developed using Unity Release [2021.3.11f1](https://unity3d.com/unity/whats-new/2021.3.11).
This project is developed using Unity Release
[2021.3.11f1](https://unity3d.com/unity/whats-new/2021.3.11).
Install this version of Unity from Unity Hub using this link:
[unityhub://2021.3.11f1/0a5ca18544bf](unityhub://2021.3.11f1/0a5ca18544bf).

Expand Down

0 comments on commit e8d65a0

Please sign in to comment.