diff --git a/.gitignore b/.gitignore index a93263d..33b1557 100644 --- a/.gitignore +++ b/.gitignore @@ -18,6 +18,16 @@ data_*/ *.TMP *.translation +# Builds: +builds/linux/* +builds/mac/* +builds/web/* +builds/windows/* +!builds/linux/.empty +!builds/mac/.empty +!builds/web/.empty +!builds/windows/.empty + # Ignore: ignore/* !ignore/.gdignore diff --git a/builds/.gdignore b/builds/.gdignore new file mode 100644 index 0000000..e69de29 diff --git a/builds/linux/.empty b/builds/linux/.empty new file mode 100644 index 0000000..e69de29 diff --git a/builds/mac/.empty b/builds/mac/.empty new file mode 100644 index 0000000..e69de29 diff --git a/builds/readme.md b/builds/readme.md new file mode 100644 index 0000000..21b52e3 --- /dev/null +++ b/builds/readme.md @@ -0,0 +1,83 @@ +# Building The House Always Wins +[Go back](../readme.md) + +# Contents +1. [Exporting from Godot Engine](#exporting-from-godot-engine) + * [Pre-cleaning](#pre-cleaning) + * [Exporting](#exporting) +2. [Distributing to itch.io](#distributing-to-itchio) + * [Updating butler](#updating-butler) + * [Using butler](#using-butler) +3. [Distributing to GitHub](#distributing-to-github) + +# Exporting from Godot Engine +Different versions of the game expect different versions of Godot Engine. Make +sure you are using the correct versions before you open the project in Godot +Engine. + +| Game version | Godot Engine version | +| -----------: | :------------------- | +| Development | `3.5.1` | +| v`1.1.2` | `3.5.1` | +| v`1.1.1` | `3.4.4` | +| v`1.1.0` | `3.4.4` | +| v`1.0.0` | `3.4.4` | +| v`1.0.0-jam` | `3.4.4` | + +If you are using game version `1.1.1` or below, these instructions will not be +accurate. + +## Pre-cleaning +Godot Engine will allow you to overwrite exported files but it is recommended +to delete old exported files before you begin. This means all files in the +`linux/`, `mac/`, `web/`, and `windows/` directories in this directory except +for their `.empty` files. + +The `.empty` files allow these directories to appear in Git if they otherwise +contain no files. All other files in these directories are ignored by Git. + +## Exporting +Use the following steps to export the game from Godot Engine: + +1. Open the project in the correct version of Godot Engine. +2. Wait for any assets to be reimported. (A progress bar may appear.) +3. Make sure you have export templates and export tools +(such as [rcedit](https://github.com/electron/rcedit)) set up in Godot Engine's +settings. +4. Select `Project > Export...` to open the 'Export' menu. +5. Select `Export All... > Release` to begin exporting the game. +6. Wait for the exporting process to finish. You may now close Godot Engine. + +# Distributing to itch.io +Builds of the game are distributed to +[itch.io](https://ruxaroh.itch.io/the-house-always-wins) using their command +line tool, [butler](https://itch.io/docs/butler). Please see the documentation +for more information. + +## Updating butler +If you have butler installed, you can update it from the command line by using +the following command. +``` +butler upgrade +``` + +## Using butler +The following butler commands are used from this directory to push builds to +itch.io. +``` +butler push --ignore=.empty --userversion-file=version.txt web ruxaroh/the-house-always-wins:web +butler push --ignore=.empty --userversion-file=version.txt windows ruxaroh/the-house-always-wins:windows +butler push --ignore=.empty --userversion-file=version.txt mac ruxaroh/the-house-always-wins:mac +butler push --ignore=.empty --userversion-file=version.txt linux ruxaroh/the-house-always-wins:linux +``` + +`version.txt` holds the version that will be displayed on itch.io. It should be +written in UTF-8 without a byte order mark and avoid leading and trailing +whitespace. + +# Distributing to GitHub +Builds in `.zip` files on the +[GitHub releases page](https://github.com/krobbi/gmtk-2022/releases) are ripped +from the itch.io game page by selecting `Edit game` and selecting +`More... > Download` on each release channel. Because of this, tags and +releases are published on GitHub after the game is available on itch.io. diff --git a/builds/version.txt b/builds/version.txt new file mode 100644 index 0000000..8428158 --- /dev/null +++ b/builds/version.txt @@ -0,0 +1 @@ +1.1.2 \ No newline at end of file diff --git a/builds/web/.empty b/builds/web/.empty new file mode 100644 index 0000000..e69de29 diff --git a/builds/windows/.empty b/builds/windows/.empty new file mode 100644 index 0000000..e69de29 diff --git a/export_presets.cfg b/export_presets.cfg index 074e092..55bc074 100644 --- a/export_presets.cfg +++ b/export_presets.cfg @@ -7,7 +7,7 @@ custom_features="" export_filter="all_resources" include_filter="" exclude_filter="" -export_path="ignore/builds/web/index.html" +export_path="builds/web/index.html" script_export_mode=1 script_encryption_key="" @@ -42,7 +42,7 @@ custom_features="" export_filter="all_resources" include_filter="" exclude_filter="" -export_path="ignore/builds/windows/the-house-always-wins.exe" +export_path="builds/windows/the-house-always-wins.exe" script_export_mode=1 script_encryption_key="" @@ -66,9 +66,10 @@ codesign/timestamp_server_url="" codesign/digest_algorithm=1 codesign/description="" codesign/custom_options=PoolStringArray( ) +application/modify_resources=true application/icon="res://resources/textures/icon.ico" -application/file_version="1.0.0" -application/product_version="1.1.1" +application/file_version="1.0.0.0" +application/product_version="1.1.2.0" application/company_name="Sloogat" application/product_name="The House Always Wins" application/file_description="Control fate by shifting the odds in your favour!" @@ -84,7 +85,7 @@ custom_features="" export_filter="all_resources" include_filter="" exclude_filter="" -export_path="ignore/builds/mac.zip" +export_path="builds/mac/the-house-always-wins.app" script_export_mode=1 script_encryption_key="" @@ -99,11 +100,52 @@ application/identifier="io.github.krobbi.gmtk-2022" application/signature="" application/app_category="Games" application/short_version="1.1" -application/version="1.1.1" +application/version="1.1.2" application/copyright="2022 Ruxaroh, Krobbizoid" display/high_res=false -privacy/camera_usage_description="" privacy/microphone_usage_description="" +privacy/camera_usage_description="" +privacy/location_usage_description="" +privacy/address_book_usage_description="" +privacy/calendar_usage_description="" +privacy/photos_library_usage_description="" +privacy/desktop_folder_usage_description="" +privacy/documents_folder_usage_description="" +privacy/downloads_folder_usage_description="" +privacy/network_volumes_usage_description="" +privacy/removable_volumes_usage_description="" +codesign/enable=true +codesign/identity="" +codesign/timestamp=true +codesign/hardened_runtime=true +codesign/replace_existing_signature=true +codesign/entitlements/custom_file="" +codesign/entitlements/allow_jit_code_execution=false +codesign/entitlements/allow_unsigned_executable_memory=false +codesign/entitlements/allow_dyld_environment_variables=false +codesign/entitlements/disable_library_validation=false +codesign/entitlements/audio_input=false +codesign/entitlements/camera=false +codesign/entitlements/location=false +codesign/entitlements/address_book=false +codesign/entitlements/calendars=false +codesign/entitlements/photos_library=false +codesign/entitlements/apple_events=false +codesign/entitlements/debugging=false +codesign/entitlements/app_sandbox/enabled=false +codesign/entitlements/app_sandbox/network_server=false +codesign/entitlements/app_sandbox/network_client=false +codesign/entitlements/app_sandbox/device_usb=false +codesign/entitlements/app_sandbox/device_bluetooth=false +codesign/entitlements/app_sandbox/files_downloads=0 +codesign/entitlements/app_sandbox/files_pictures=0 +codesign/entitlements/app_sandbox/files_music=0 +codesign/entitlements/app_sandbox/files_movies=0 +codesign/custom_options=PoolStringArray( ) +notarization/enable=false +notarization/apple_id_name="" +notarization/apple_id_password="" +notarization/apple_team_id="" texture_format/s3tc=true texture_format/etc=false texture_format/etc2=false @@ -117,7 +159,7 @@ custom_features="" export_filter="all_resources" include_filter="" exclude_filter="" -export_path="ignore/builds/linux/the-house-always-wins.x86_64" +export_path="builds/linux/the-house-always-wins.x86_64" script_export_mode=1 script_encryption_key="" diff --git a/project.godot b/project.godot index d3262eb..d71019e 100644 --- a/project.godot +++ b/project.godot @@ -99,8 +99,10 @@ file_logging/enable_file_logging.pc=false [physics] common/enable_pause_aware_picking=true +3d/active_soft_world=false [rendering] +2d/options/use_nvidia_rect_flicker_workaround=true environment/default_clear_color=Color( 0.180392, 0.14902, 0.301961, 1 ) environment/default_environment="res://resources/environments/default_env.tres" diff --git a/readme.md b/readme.md index 55d3d54..ca7879f 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,7 @@ # The House Always Wins -Copyright © 2022 [Ruxaroh](https://github.com/ruxaroh), -[Krobbizoid](https://github.com/krobbi). +__Version `1.1.2`__ - Godot Engine version `3.5.1`. +__Copyright © 2022 [Ruxaroh](https://github.com/ruxaroh), +[Krobbizoid](https://github.com/krobbi).__ # Contents 1. [About](#about) @@ -9,6 +10,8 @@ Copyright © 2022 [Ruxaroh](https://github.com/ruxaroh), 4. [Description](#description) 5. [Credits](#credits) 6. [Exporting](#exporting) + * [Exporting Versions 1.1.2 and Above](#exporting-versions-112-and-above) + * [Exporting Versions 1.1.1 and Below](#exporting-versions-111-and-below) # About The House Always Wins is a game originally created within 48 hours for the @@ -72,6 +75,16 @@ https://soundcloud.com/ghostrifter-official/on-my-way Creative Commons CC BY-SA 3.0: https://creativecommons.org/licenses/by-sa/3.0 # Exporting +The steps for exporting the game depend on its version. Make sure you are +following the correct instructions. + +## Exporting Versions 1.1.2 and Above +For detailed instructions on exporting and distributing the latest versions of +the game, see [builds/readme.md](./builds/readme.md). + +## Exporting Versions 1.1.1 and Below +The following instructions only apply to game versions `1.1.1` and below. + To export the game, use Godot Engine `3.4.4`. Make sure you have the following empty directories inside the Godot project: diff --git a/scenes/credits/credits.tscn b/scenes/credits/credits.tscn index 9c04c76..c49cfa1 100644 --- a/scenes/credits/credits.tscn +++ b/scenes/credits/credits.tscn @@ -70,7 +70,7 @@ margin_top = -168.0 margin_right = -152.0 margin_bottom = -72.0 custom_fonts/font = ExtResource( 6 ) -text = "v1.1.1" +text = "v1.1.2" align = 2 valign = 2 __meta__ = {