valks-games / sankari

A open source 2D platformer being made in Godot 4 beta C#

Video of Gameplay

Preview.1.mp4

Preview.3.mp4

Preview.4.mp4

What is Sankari?

Sankari ("hero" in Finnish) is a non-profit F2P 2D Platformer about a hero whose village gets raided by the evil king. The hero goes on a journey to free back the villagers that were captured and defeat the evil king.

This project was created to gain experience in the C# Godot environment for the 2D Platform genre and to prove to myself that I can make a complete game. I hope in making this open source that others will also learn some things that I have learned.

The project will be considered complete when there is around 2 to 3 hours of fun and memorable content. Some of the major goals of the project include getting multiplayer to a playable state and making the code as flexible and as readable as possible.

If you have any questions or suggestions about the project or just want to talk to me in general, my Discord username is va#9904. You can also find me on the Sankari Discord.

Changelog

Roadmap

• Use Godot scenes instead of one big master node handling all scene nodes. This will allow for easier testing of inidivual scenes in the future.
• Wrap my head around the current codebase. Make the code look nicer. Make it less confusing to the reader.
• Figure out why "Load First Level" option is not working as intended. (First level is loaded but map screen is hiding the level)
• Tinker with the player movement more to get that more snappier platformer like feel.
• Introduce new water tiles.

Project Setup

1. Install the latest Godot 4 C# release
2. Install .NET SDK 6.0
3. Install .NET Framework 4.7.2
4. In Godot Editor > Editor Settings > Mono > Builds: Make sure Build Tool is set to dotnet CLI

Contributing

I am a coder

I am a artist

I am a level designer

I am a musician

License

Project

This project is under the MIT license

Assets

• Most assets (art / audio) are under the CC0 license from Open Game Art
• Some of the audio is from Mixkit under the Mixkit license
• The networking library ENet-CSharp is under the MIT license

Credit

Thank you to the following wonderful people that helped make this project something even better

AdamLaine
Dunkhan
Muftwin
Policiu

sankari's Issues

Coin pickup sound is not satisfying enough

Saving The Game

What information should be saved when saving the game?

• should there be icons the map that save the game like in super mario world?
• should saving be available at all times and save the players exact position along with enemies current positions?

Walking enemy should not walk off cliffs if setting is enabled

Parallax Backgrounds For Each Map Region

Each map region should have one or more parallax backgrounds. Grassy plains will be a region for sure in the game.

Parallax Background Checklist

• Outside Summer Forest [1] [2] [3]
• Inside Summer Forest [1] [2] [3] [4]
• Barren Wasteland [1]
• Snowy [1]
• Space [1] [2] [3]
• Desert [1] [2]
• Volcanic
• Clouds / Sky
• Underground Caves

Here is an example of what a parallax background looks like

Parallax.mp4

The tileset art is currently 16x16 in size. This may change in the future. Why does this matter? The higher the tile resolution, the higher the parallax background resolution. In the video above the tileset is 8x8 so you can see the super low resolution of the parallax background here.

Player Should Not Go Into Wall Jumping Mode When Near Walls That Should Not Be Wall Jumpable

Issue

If you look at 2.mp4 you can see how annoying this really is.

Possible Solutions

• Only make certain tiles wall jumpable (hard to do since you can only reference tiles by their IDs and tiles IDs like to change if you change the order of the tiles. In other words you can't do if this tile is the sand tile then do this, you can only do the following in code if this tile is 1 then do this

• Don't make tiles wall jumpable, but rather use collision box areas that are wall jumping zones

1.mp4

2.mp4

Migrating parts of the Godot Modules project over to this project

Despite the project "Godot Modules" having "Modules" in the name, it is not very modular as it is very hard to extract certain parts of it out like for example the options scripts to merge them in with another project.

Link to Godot Modules project https://github.com/GodotModules/GodotModulesCSharp

I would like to take the option scripts and maybe a few other things and merge them in with this project.

Current animated water tile needs to be adjusted to fit current tileset

ENet-CSharp

Reminder to myself to implement ENet-CSharp from the Godot Modules project to here.

Enemy should be queue freed when it touches the "Bottom" Area2D

All levels have a area called "Bottom" to prevent the player from falling off.

A enemy should be destroyed if it touches this area.

I can do all of this, I'm just creating this issue as a reminder to myself.

The Place Where You Define Music For Each Level Is In A Weird Spot

sankari/Scripts/Map/Map.cs

Lines 64 to 71 in d73150c

	var levelA1 = _levelManager.LevelNames["Level A1"];
	levelA1.Locked = false;
	levelA1.Music = "grassy_1";
	levelA1.MusicPitch = 0.9f;
	var levelA2 = _levelManager.LevelNames["Level A2"];
	levelA2.Music = "grassy_2";
	levelA2.MusicPitch = 0.9f;

I will add more info to this issue later sorry.

Only move enemy if player enters specific area2d

Platforms That Move Back And Fourth With Tween Node

The Goal

Click on the image below to watch a video from Game Endeavor explaining how to create platforms that move back and fourth with the Tween node.

What do the platforms look like right now?

1.mp4

2.mp4

3.mp4

What the code looks like right now?

Nothing fancy at the moment

sankari/Scripts/MovingPlatform.cs

Lines 1 to 11 in f8e4ce1

	namespace MarioLikeGame;
	public class MovingPlatform : KinematicBody2D
	{
	public override void _PhysicsProcess(float delta)
	{
	var pos = Position;
	pos.x += 0.1f;
	Position = pos;
	}
	}

Instantly load a level on game startup (making life easier on level designers)

Need Animated Lava Tile / Spikes Sprite

Stop the camera from following the player when the player is in the death animation

Player Should Not Go Into Wall Jump Mode When Jumping Through A Platform

1.mp4

What Should Coins Do?

I want to add some kind of collectible (coins or gems or something shiny you know) to each level but I'm not sure what they should do. Should they increase the game score? Affect player lives? Act as a currency for a shop? Or do nothing and just increase a number on your screen that you can brag about to your friends.

Level 1 is too easy

Level 1 needs to be more difficult. Perhaps this is due to a lack of game assets right now. Feel free to try making the level more difficult with the current games assets.

Orange ball enemies should not collide with each other

Level 1 needs parallax background

There needs to be a parallax background for level 1 but there are no bright grassy hilly / plains in #12

Giving Specific Names To Tiles In A Tilemap

https://kidscancode.org/godot_recipes/2d/tilemap_collision/

Things this can be used for

• player slides on ice
• player moves slower in water
• player receives lava / fire damage
• instant kill zones
• wall jumpable tiles
• bouncy tiles

Allow level designer to see whole level while in game or fly hack

Dynamic Camera

If you're a player at the top of this slope, you can't see what's ahead below of you.

Player Dashing Is Not The Best Right Now

I want to do something similar to Celestes player dashing

Issue

Dashing feels clunky right now. In the video below you see what dashing looks like however it was hard to achieve this as most times dashing does not work as it's based on the players current velocity so most dashes are super weak or even go in the opposite direction you want sometimes.

What dashing looks like right now

Dashing.mp4

Code

sankari/Scripts/Player/Player.cs

Lines 124 to 143 in f8e4ce1

	// dash
	if (_inputDash && _dashReady)
	{
	_dashReady = false;
	_currentlyDashing = true;
	_timerDashDuration.Start();
	_timerDashCooldown.Start();
	}
	if (_currentlyDashing)
	{
	var sprite = Prefabs.PlayerDashTrace.Instance<Sprite>();
	sprite.GlobalPosition = GlobalPosition;
	GetTree().Root.AddChild(sprite);
	_velocity += _moveDir * 1000;
	_gravity = 0;
	}
	else
	_gravity = GRAVITY_AIR;

Slime / Frog Enemy Needs To Be Animated

Use the green enemy at top in this image.

Map Movement Could Be Considered Tedious?

Right now with map movement you have to tap the right arrow twice to get to the next level. Tapping the right arrow once to get to the next level would be nice. Keep in mind that the map level placements are not just left to right, they could be placed in all 4 directions up, down, left, right. Look at how Super Mario World (SNES) does it. I want to do something similar to that where you tap right arrow (or whatever direction) once, and you see the animation of the player lerping to the new level but always following the path. Or should the game map be kept as is?

Player Stomp

Player should thrust themselves downwards and smash whatever is below them.

Need better sliding down slope physics

preview.mp4

I feel like the player should go down the slope continuously and not come to a halt.

Some One-Way Platforms Should Allow The Player To Press S To Go Underneath Them

Should Enemy Be Deleted In Each Individual Enemy Script Or Should Enemy Be Deleted In A Script Attached To The Area2D Called "Bottom" (The bottom of the level)

Writing the delete code in each enemy script would be tedious but maybe this is the right way to do things?

If the delete code was put in a script attached to "Bottom" node then I would just check if the node is in the group called "Enemy" and delete it.

Jump Force When Player Is On A Slope Is Too Weak And Feels Weird

What should happen

The jumps on slopes should feel more powerful and maybe more upward? I'm not sure.

Preview of what the player jumping on slopes looks like right now

1.mp4

2.mp4

Do not play player death animation if killed by the bottom area

Holding Space Longer = Higher Jump

Tapping space should give a tiny jump and holding space should give a longer jump.

Game Lighting

Point light sources / dynamic sun sets etc.

Created this issue as a reminder. Not much to see here right now.

Platform That Moves In A Circle Motion

Crusher AI

Crusher should automatically find the point where it needs to crush based on the tiles created under it. Detection of tiles should start from A to B.

And of course try to crush the player if it detects the player underneath it.

I can do all of this, I'm just creating this issue as a reminder to myself.

Underwater Tiles Slow Down Players Movement

Created a separate issue for this even though it was mentioned in #15 as it seems like something that should be in the game for sure.

Should I Use A State Machine For The Player Code?

I have seen people use state machines in tutorials for player movement but this often involves a lot of duplicate code but I guess the main player state manager script would have a bunch of methods to reduce the duplicate code. I have tried this before but it made the player logic much more complicated and many issues arose. For example the player was not jumping because they were not in a state that would allow jumping. (The switching of states was too slow, a frame behind causing big annoyance)

Hard to see where circle platform will be going in editor

Perhaps a circle area should be used to determine the radius instead of guessing the radius via integer

Platform That Follows A Non-Linear Path With Sync To Physics Enabled

Level placement of coins is tedious. Helpers should be made to help with this.

Placing coins requires the level designer to copy paste coins which in Godot can prove to become tedious. There should be scripts to help automate this.

There should be a script that places coins in a circle (whether it be just the outline or the full circle) and a script for placing coins in a row. Disabled Area2D's should be used to get the radius / width of where the coins should go. To get an idea of how Area2D's are to be used, have a look at the prefab in res://Scenes/Prefabs/Platforms/Platform Circle.tscn

For the circle coin helper the properties should look something as follows

[Export] public bool onlyOutline; // if disabled, circle and outline are filled with coins distributed evenly
// no need for radius property as it's handled by the Area2D

For the row coin helper the properties should look something as follows

// no properties as Area2D tells script everything it needs to know (where the coins need to go)

Need level designer to make levels 2, 3, 4

Follow this template when making a new level

• Make sure the LevelScene.cs script is attached to the node called Level A1 (or whatever the level is called, change the node name to that)
  

• Each level has a long blue rect called "Bottom" that kills the player if they touch it preventing them from falling endlessly out of the level

• You will also notice a yellow rect, this is the camera limit (bounds) of the level, the camera won't go past these lines, set them to the bounds of the level
  

For platforms once you for e.g. copy in a "MovingPlatform" scene, make the scene have editable children and drag the target position where you want the platform to go to.

Circle platforms circle around the point in which they are placed.

Take note platforms have public variables you can edit to set their delays and speeds.

If you have any questions please ask in the Discord.

Different Size Variations Of Same Enemy

This enemy should have different size variations. Maybe a size a little smaller and a few variations of sizes much bigger than it is now. A script should be thought of to make life easier when dealing with this. Perhaps a abstract script called "ABasicEnemy.cs" that all BasicEnemy.cs inherit from. I'm not sure.

Player Can Not Go Up 45 Degree Slopes Without Jumping

Issue

You currently can't go up a slope whilst just holding the right movement key.

Expected

You should be able to traverse a slope like this without having to jump.

Preview

SlopeJump.mp4

What can be added to the game to make levels more interesting?

You can see the cut off for the parallax background in the front (the blue stick trees)

issue.mp4

Question About Using Modot (C# Godot Mod Loader)

I found this but I'm not sure how to use it to its full potential https://github.com/Carnagion/Modot

I see in the wiki they give an example of how to access the main scene tree but what if I wanted to for e.g. modify the player jumps to be more powerful through a mod? Or spawn more enemies in a level in specific locations? All the things mods can do, what are the limitations of this modloader?

Dependency Injection or Static? And what about singletons?

Should I have a game manager super class that has references to all the other manager scripts like audio manager and level manager and pass this reference of game manager to everything and access everything through game manager script OR should I make game manager and/or some of the other managers static as well and just watch out for cleanup after using static. Also what's the deal with singletons, what's the point of them? I feel like singletons make readability worse. Why not make everything static in the class so it's easier to type?

SFX / Music files need to be sorted better

At first I thought sorting the assets in folders by the artists names would work but this is proving to be very messy and hard to find stuff. Sorting them by their attributes would be a lot better. For example, a icy soundtrack should go into a folder called "Ice". A player dash should go into a folder called "Movement" or "Player/Movement"

Make sure you also edit the path names in Audio.cs script

Platform That Disappears When The Player Touches It Then Reappears

There should be a platform that disappears x seconds after a player touches it and reappears after y seconds. The platform should flash a white tint indicating to the player that the platform is about to do something.