Skip to content

Commit

Permalink
ported match3-board from indie pipeline organization and fixed minor …
Browse files Browse the repository at this point in the history
…bugs
  • Loading branch information
ninetailsrabbit committed Oct 12, 2024
1 parent 66203af commit c1f221e
Show file tree
Hide file tree
Showing 56 changed files with 2,688 additions and 33 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Contribution

Existing issues marked with a [help wanted tag](https://github.com/ninetailsrabbit/[PLUGIN]/labels/help%20wanted) are the best candidates for contributions. Issues with that tag are either not prioritised, or are in need of help with someone with more expertise within a certain area
Existing issues marked with a [help wanted tag](https://github.com/ninetailsrabbit/match3-board/labels/help%20wanted) are the best candidates for contributions. Issues with that tag are either not prioritised, or are in need of help with someone with more expertise within a certain area

## Reporting bugs

1. **[Follow the template for bug reports.](https://github.com/ninetailsrabbit/[PLUGIN]/issues/new?assignees=ninetailsrabbit&labels=%F0%9F%90%9B+bug&projects=&template=bug_report.md&title)**
1. **[Follow the template for bug reports.](https://github.com/ninetailsrabbit/match3-board/issues/new?assignees=ninetailsrabbit&labels=%F0%9F%90%9B+bug&projects=&template=bug_report.md&title)**
2. **Golden rule** Open _one_ ussie for _one_ bug .
3. [Search for existing reports first.](https://github.com/ninetailsrabbit/[PLUGIN]/issues) If you found a similar issue in the tracker - better share your problem in the existing thread.
3. [Search for existing reports first.](https://github.com/ninetailsrabbit/match3-board/issues) If you found a similar issue in the tracker - better share your problem in the existing thread.
4. Besides the platform, specify as many specifics as you can _(if relevant)_. CPU/GPU, input methods _(controller, mouse)_ and so on.
5. A simple reproduction project helps more than any reproduction steps. Include it whenever you can. Examining the problem first-hand is the easiest way to solve it.

## Proposing features

1. **[Follow the template for feature requests.](https://github.com/ninetailsrabbit/[PLUGIN]/issues/new?assignees=ninetailsrabbit&labels=%E2%AD%90+feature&projects=&template=feature_request.md&title)**
2. [Search for existing proposals first.](https://github.com/ninetailsrabbit/[PLUGIN]/issues)
1. **[Follow the template for feature requests.](https://github.com/ninetailsrabbit/match3-board/issues/new?assignees=ninetailsrabbit&labels=%E2%AD%90+feature&projects=&template=feature_request.md&title)**
2. [Search for existing proposals first.](https://github.com/ninetailsrabbit/match3-board/issues)
3. Request something with a real-world use-case. Abstract features may not be considered.
4. If you are capable of implementing said feature, include some code that demonstrates the finer details/nuances of said feature.

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<div align="center">
<img src="icon.svg" alt="Logo" width="160" height="160">

<h3 align="center">PLUGIN NAME</h3>
<h3 align="center">Match3 Board</h3>

<p align="center">
PLUGIN DESCRIPTION
The core logic and functionality you need to build engaging match-3 games
<br />
·
<a href="https://github.com/ninetailsrabbit/[PLUGIN]/issues/new?assignees=ninetailsrabbit&labels=%F0%9F%90%9B+bug&projects=&template=bug_report.md&title=">Report Bug</a>
<a href="https://github.com/ninetailsrabbit/match3-board/issues/new?assignees=ninetailsrabbit&labels=%F0%9F%90%9B+bug&projects=&template=bug_report.md&title=">Report Bug</a>
·
<a href="https://github.com/ninetailsrabbit/[PLUGIN]/issues/new?assignees=ninetailsrabbit&labels=%E2%AD%90+feature&projects=&template=feature_request.md&title=">Request Features</a>
<a href="https://github.com/ninetailsrabbit/match3-board/issues/new?assignees=ninetailsrabbit&labels=%E2%AD%90+feature&projects=&template=feature_request.md&title=">Request Features</a>
</p>
</div>

Expand All @@ -20,11 +20,11 @@

# 📦 Installation

1. [Download Latest Release](https://github.com/ninetailsrabbit/[PLUGIN]/releases/latest)
2. Unpack the `addons/[PLUGIN]` folder into your `/addons` folder within the Godot project
1. [Download Latest Release](https://github.com/ninetailsrabbit/match3-board/releases/latest)
2. Unpack the `addons/ninetailsrabbit.match3_board` folder into your `/addons` folder within the Godot project
3. Enable this addon within the Godot settings: `Project > Project Settings > Plugins`

To better understand what branch to choose from for which Godot version, please refer to this table:
|Godot Version|[PLUGIN] Branch|[PLUGIN] Version|
|Godot Version|match3-board Branch|match3-board Version|
|---|---|--|
|[![GodotEngine](https://img.shields.io/badge/Godot_4.3.x_stable-blue?logo=godotengine&logoColor=white)](https://godotengine.org/)|`main`|`1.x`|
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@

## Reporting a Vulnerability

Please [raise an issue](https://github.com/ninetailsrabbit/[PLUGIN]/issues) in case you find a security issue.
Please [raise an issue](https://github.com/ninetailsrabbit/match3-board/issues) in case you find a security issue.
7 changes: 0 additions & 7 deletions addons/my_plugin/plugin.cfg

This file was deleted.

23 changes: 23 additions & 0 deletions addons/ninetailsrabbit.match3_board/assets/board.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions addons/ninetailsrabbit.match3_board/assets/board.svg.import
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[remap]

importer="texture"
type="CompressedTexture2D"
uid="uid://dp0rg1kjqppec"
path="res://.godot/imported/board.svg-1538b9ec53988ab8c30ff9f4bfcc2ea5.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/ninetailsrabbit.match3_board/assets/board.svg"
dest_files=["res://.godot/imported/board.svg-1538b9ec53988ab8c30ff9f4bfcc2ea5.ctex"]

[params]

compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1
svg/scale=1.0
editor/scale_with_editor_scale=false
editor/convert_colors_with_editor_theme=false
6 changes: 6 additions & 0 deletions addons/ninetailsrabbit.match3_board/assets/piece.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions addons/ninetailsrabbit.match3_board/assets/piece.svg.import
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[remap]

importer="texture"
type="CompressedTexture2D"
uid="uid://ckafybol0kwqg"
path="res://.godot/imported/piece.svg-1960013a83aa536b201c3cf2a3335f60.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/ninetailsrabbit.match3_board/assets/piece.svg"
dest_files=["res://.godot/imported/piece.svg-1960013a83aa536b201c3cf2a3335f60.ctex"]

[params]

compress/mode=0
compress/high_quality=false
compress/lossy_quality=0.7
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=false
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/fix_alpha_border=true
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1
svg/scale=1.0
editor/scale_with_editor_scale=false
editor/convert_colors_with_editor_theme=false
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://qjmv3cxry8wu"
path="res://.godot/imported/progress-background.png-998a5bde492cb044f40021717cd2a939.ctex"
path="res://.godot/imported/progress-background.png-f9deb8d5d9b136dfe8b90954b7037c64.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/my_plugin/assets/progress-background.png"
dest_files=["res://.godot/imported/progress-background.png-998a5bde492cb044f40021717cd2a939.ctex"]
source_file="res://addons/ninetailsrabbit.match3_board/assets/progress-background.png"
dest_files=["res://.godot/imported/progress-background.png-f9deb8d5d9b136dfe8b90954b7037c64.ctex"]

[params]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://bdf47suvxkr8l"
path="res://.godot/imported/progress_background_green.png-6d408d66d9d96656254b6aea57ff2db6.ctex"
path="res://.godot/imported/progress_background_green.png-49a36c7309ca9c7c5168a30ca91409e1.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/my_plugin/assets/progress_background_green.png"
dest_files=["res://.godot/imported/progress_background_green.png-6d408d66d9d96656254b6aea57ff2db6.ctex"]
source_file="res://addons/ninetailsrabbit.match3_board/assets/progress_background_green.png"
dest_files=["res://.godot/imported/progress_background_green.png-49a36c7309ca9c7c5168a30ca91409e1.ctex"]

[params]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ func _enter_tree() -> void:
if not DirAccess.dir_exists_absolute(MyPluginSettings.PluginTemporaryReleaseUpdateDirectoryPath):
DirAccess.make_dir_recursive_absolute(MyPluginSettings.PluginTemporaryReleaseUpdateDirectoryPath)

add_custom_type("Match3Board", "Node2D", preload("src/match3_board.gd"), preload("assets/board.svg"))
add_custom_type("PieceDefinitionResource", "Resource", preload("src/components/pieces/piece_definition_resource.gd"), preload("assets/piece.svg"))


func _exit_tree() -> void:
MyPluginSettings.remove_settings()
Expand All @@ -20,6 +23,9 @@ func _exit_tree() -> void:
update_notify_tool_instance.free()
update_notify_tool_instance = null

remove_custom_type("PieceDefinitionResource")
remove_custom_type("Match3Board")

## Update tool referenced from https://github.com/MikeSchulze/gdUnit4/blob/master/addons/gdUnit4
func _setup_updater() -> void:
if MyPluginSettings.is_update_notification_enabled():
Expand Down
7 changes: 7 additions & 0 deletions addons/ninetailsrabbit.match3_board/plugin.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[plugin]

name="Match3-Board"
description="This lightweight library provides the core logic and functionality you need to build engaging match-3 games. Focus on game design and mechanics while leaving the complex logic to this library"
author="Ninetailsrabbit"
version="1.0.0"
script="ninetailsrabbit.match3_board.gd"
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
@tool
class_name MyPluginSettings extends RefCounted

const PluginPrefixName: String = "my_plugin" ## The folder name
const GitRepositoryName: String = "my-plugin"
const PluginPrefixName: String = "ninetailsrabbit.match3_board" ## The folder name
const GitRepositoryName: String = "match3-board"

static var PluginName: String = "MyPlugin"
static var PluginProjectName: String = ProjectSettings.get_setting("application/config/name")
Expand Down
Loading

0 comments on commit c1f221e

Please sign in to comment.