Skip to content

Commit 56c9ed4

Browse files
committed
Merge branch 'master' of https://github.com/BlueVoidStudios/Nano
2 parents df3b527 + 99377af commit 56c9ed4

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
![Nano logo](https://raw.githubusercontent.com/BlueVoidStudios/Nano/master/Media/GitHub_Logo.png)
2+
3+
Nano is a tiny UE4 template designed for people who want to make tiny games. It was inspired by a special award in Epic's #ue4jam that goes to the best game under 100 MB. This award tends to raise a lot of questions in the community about how to make a UE4 game so small, so I decided to create a template that does most of the heavy lifting for you!
4+
5+
## Benchmarks
6+
Here's how Nano compares to the blank template that ships with UE4:
7+
8+
> Numbers are based on the Shipping build configuration
9+
10+
| | 64-bit | 32-bit |
11+
| ----- | ------ | ------ |
12+
| Blank | 181 MB | 150 MB |
13+
| Nano | 116 MB | 85 MB |
14+
15+
You can take this even further if you exclude the prerequisites installer:
16+
17+
| | 64-bit | 32-bit |
18+
| ----- | ------ | ------ |
19+
| Blank | 141 MB | 126 MB |
20+
| Nano | 76 MB | 62 MB |
21+
22+
_Please keep in mind: excluding the prerequisites installer means your game may not work for players who have never installed a UE4-based game before. This is probably fine for most people during the #ue4jam, but if you want your game to be accessible to everyone, skip this step!_
23+
24+
## How it works
25+
To help achieve its small size, Nano comes out of the box with the following configuration:
26+
27+
- Windows only
28+
- DirectX 11 & 12 only
29+
- No editor startup map
30+
- No editor content
31+
- Shared material code & libraries
32+
- Compressed cooked packages
33+
- Oculus VR and Steam VR plugins disabled
34+
35+
There are ways to reduce the size even further, but I decided to focus on the modifications that had significant results while remaining safe and usable for most people.
36+
37+
## Instructions
38+
To use Nano, download the latest release and copy it to your templates directory (e.g. `Epic Games/UE_4.22/Templates/`). Once you do this, Nano should appear as a template option in the New Project dialog.
39+
40+
![New Project dialog screenshot]()
41+
42+
### Packaging your game
43+
- **Visual Studio is required to package your game with Nano.** This is because the VR plugins are disabled. You don't have to use it; just install it with the configuration picture below and you should be good to go.
44+
45+
![Visual Studio configuration]()
46+
47+
- Nano is configured for development out of the box. When it's time to package the final version of your game, don't forget to set your build config to Shipping!
48+
49+
## Credits
50+
- The font used in the Nano logo is [Playlines](https://creativemarket.com/putracetol/2962806-Playlines-Typeface) by PutraCetol Studio
51+
- Whomever at Epic Games wrote [this article]() on reducing your package size
52+
- Heff, Tate Hartel, and AzorMachine from the #gamejams channel on [Unreal Slackers](https://unrealslackers.org) for their tips on reducing package size

0 commit comments

Comments
 (0)