Skip to content

Commit 6f618c9

Browse files
committed
feat: create first version of fog of war
1 parent 08bbf28 commit 6f618c9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+2319
-66
lines changed

CHANGELOG.md.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CODE_OF_CONDUCT.md.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CONTRIBUTING.md.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Editor.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Editor/open-source-unity-package.fog-of-war.Editor.asmdef.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

LICENSE.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<h1 align="center" style="border-bottom: none;">Unity package template📦 </h1>
2-
<h3 align="center">Fully automated version management and package publishing</h3>
1+
<h1 align="center" style="border-bottom: none;">Fog of war📦 </h1>
2+
<h3 align="center">2D fog of war for unity</h3>
33
<p align="center">
44
<a href="https://github.com/semantic-release/semantic-release/actions?query=workflow%3ATest+branch%3Amaster">
55
<img alt="Build states" src="https://github.com/semantic-release/semantic-release/workflows/Test/badge.svg">
@@ -21,31 +21,8 @@
2121
</p>
2222

2323
## What is it ?
24-
Package template is a template repository to create quickly package for unity.
24+
This package is a 2D fog of war for unity based on [video](https://www.youtube.com/watch?v=MUV9Nr-cIGU) of Santzo84.
2525

26-
Unity package allow you to create independents features and include it like puzzle in your unity project to include its features.
27-
28-
This architecture is based on unity package layout presented [here](https://docs.unity3d.com/Manual/cus-layout.html)
29-
30-
I encourage you to create sample that can be imported independently thanks to unity package manager for more modularity.
31-
You can for example create demo, independent feature in your package theme...
32-
Sample folder contain character '~' that mean that this folder will be ignored by unity.
33-
All sample must be referenced in package.json.
34-
35-
Please don't change the license, and don't forget to update your changelog file and package version in package.json.
36-
For clear information about your package, make a demonstration, add description in GitHub and information in README.
37-
38-
## How to create new package ?
39-
Follow these step to create package based on this template:
40-
41-
1: Click on "Use this template" button to create a new repository based on this template.
42-
![Capture d’écran 2022-03-05 210916](https://user-images.githubusercontent.com/55276408/156898721-99195bf3-02c1-41f5-9bc8-483a9b65c55a.png)
43-
44-
2: In this step, we need add information about package that will be used to generate your package thanks to github action.
45-
- Select the owner (by default you, if you want to create a package for this repository, please select OpenSourceUnityPackage). This repository name will be used to generate the package name.
46-
- Then enter your project name. This name is very important because it will be used to generate the package name inside unity. For example TestPackageUnity will become open-source-unity-package.test-package-unity according to unity convention.
47-
- Step 2, 3 and 4 are optional. You can add description, select public repository and include all branch (to include git flow).
48-
- Now click on "select repository from template" to done this process
49-
![Capture d’écran 2022-03-05 211005](https://user-images.githubusercontent.com/55276408/156898722-cc3bf2aa-b6bd-44a1-9f74-a63d9543d1f1.png)
50-
51-
Well done ! Your package is now available. You can now develop it. Don't forgot to add complete description of it inside your README, unity and github to be community friendly ! May the opensource spirit guide your precious step ;D
26+
## How to use ?
27+
Add in your scene a fog of war script, right click on it and select "iinstall package settings". It will add layer to your projet for fog of war.
28+
If you need a demonstration, you can import demo thanks to the package manager.

README.md.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Runtime.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Runtime/Material.meta

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)