Sephy engine development document

Sephy Engine
& Based RTS Game
Jaejun-Kim
redforce01@naver.comCreated. `17.08.29

Contents
• Sephy Engine ------------------------------------------------------------------ 3
• Map Tool [Isometric Based] ------------------------------------ 26
• Unit Tool [Unit Balancing Tool] ----------------------------- 33
• Battle ------------------------------------------------------------------------------------------ 37
• Project Review ---------------------------------------------------------------- 53
• Reference ----------------------------------------------------------------------------- 54
Comment
이 프로젝트의 동영상은 Reference에 Youtube 링크로 첨부되어 있습니다.
[This Project Video Link is written on reference page at last slide page]
이 문서에는 프로젝트에 대한 모든 내용이 담겨져 있지는 않습니다.

Sephy Engine
DirectX Based 2D Engine
Jaejun-Kim
redforce01@naver.com

Sephy Engine
•Engine Spec
- Direct9 +　Win32 Based(used C, C++)
- File System Support
- TXT Data Parser Support
- 2D Collision Physics Support
- 2D Graphics Support
- Single Frame - MultiThread Worker Support
•Engine Architecture
- Main Framework
- Engine System
- Game Code
- Support Code(Utility Method)
•Engine Run Logics
- Engine System
§ Engine Boot System
§ Main System
- MainFrame Load
- Game Code Run

Engine Spec
•Direct9 Based + Win32 API
- C, C++ Language
- Win32 - x86
- Direct9
•File System
- Auto Read File In Resources Folder
- Auto Read Designated Extension File
- Write File Support - Designated Extension File
•TXT Data Parser Support
- *.txt extension File Read/Write
- Automatic parsing data Files like XML Format

Engine Spec
•2D Sprite Graphics System
- Image / Texture Manager Class
- Automatic Upload Texture To Device
- Alpha Blending (used 24bit:ARGB) Support
•2D Collision Physics Support
- Entity Class
- Collision Type
§ BOX
§ ROTATED_BOX
§ CIRCLE
§ PIXEL
- Different Collision Type Intersect Check Support
§ ex) circle to box collision
- Collision Type is Designated Based Own Sprite
Image Basically

Engine Architecture
•Single Frame - MultiThread Worker Support
- Game (Scene) Class Update Architecture
§ Game Initialize(First Call - Only One Time)
§ Update Thread
§ AI Thread
§ Collision Thread
§ RenderGame(Last Call)
Update
AI
Collision
Game
Game Thread
Create
Each Frame
Render
Game Thread
Join

Engine Architecture
- Engine System MultiThread Architecture
§ Engine Sub 4 Thread
§ ex) auto worker = Engine.GetWorkerThread();
worker->( myFunction );
§ Each Sub Thread Works Some Fuctions by Designated
Code
Engine Function B
Function C
Function A
Engine Main
Thread(Game)
Game Loop
Work Sub
Function
1. Network Connecting Check
2. File Watcher
3. Sub Programmers Code

Engine Architecture
•Main Framework
- Console
- Game
- Game Interface
- Graphics
- Input
- FileSystem
- ImageSystem
- SoundSystem
- Utility
•Engine System
- Engine Core
- Engine Main System
- Engine Boot System

Main Framework
•Console
- Engine Console is mean In Game Console System
- Programmer or player can use script their own In
console
- case our project, we use some command
§ debug, mute, help, fps, etc..
- Console Picture
Console

Main Framework
•Game Class
- Game class is mean scene
- Game class has follow next pure virtual functions
§ initialize, update, render, AI, collision, release,
releaseAll, deleteAll
- If programmers want to make new Scene,
programmer could use this class as parent class
- Initialize function needs window screen handle
- Other functions are following like generally another
game loop system

Main Framework
•Game Inteface
- Sephy Engine has basic Game Interface Code
- This Code will help easily to make UI
- Support UI Contents
§ Button(Include Image Button)
§ EditText
§ Scroll
§ Dialog
§ Progressbar
- Sample Picture [case our project - Lobby]
DialogButton

Main Framework
•Game Inteface
- Sample Picture [case our project - maptool]
Image Button Dialog
EditText
Scroll [Log]

Main Framework
•Graphics Class
- Graphics class is managing Engine's graphic
device resource and included about all graphic
information
- Basically, Sephy Engine used 24 bit color format
for sprite file
- Graphics class has drawing functions
§ drawline, drawRect, drawCircle, drawSprite
- Graphics class check Stencil Support for perfect
calculate pixel collision
- Graphics class code
§ http://redforce01.tistory.com/category/MyProject/Sephy
Engine
§ https://github.com/redforce01/SephyEngine/blob/Jaejun
-Kim/Sephy_Engine/graphics.h
-Kim/Sephy_Engine/graphics.cpp

Main Framework
•Input Class
- Input class is controlling engine's key input
message
- Input class is processes gamepad key event not
only keyboard, mouse
- the gamepad is supported only xbox pad controller
- case our project, we used keyboard and mouse
event so we are not sure the gamepad event
process working every time but maybe it's working
- Input Class Code
§ http://redforce01.tistory.com/174
-Kim/Sephy_Engine/input.h
-Kim/Sephy_Engine/input.cpp

Main Framework
•File System
- File System is a part of sephy engine's main
framework
- basically, file system find resources folder and
inspect all files
- the files are splitted 4 types following data, image,
sound, etc format
- File formats designated in source code that's
following next picture
- If File System find not designated file format, the
file would be classified other format(etc format)

Main Framework
•Image System
- Image System is depend on File System
- Sephy Engine Load Sprite (TextureFile) at Start.
If File System check All Files in Resources Folder,
Image System would upload texture to directX
device

Main Framework
•Sound System
- Sephy Engine's Sound System Used FMOD
- Sound System is depend on File System Too
- Sound System is Load Sound Files to FMOD
through designated Folder

Main Framework
•Support Code(Utility Method)
- Random Maker
§ Used <random> header
§ Used std::random_device, std::mt19937
§ Random bool, Int, pair<int, int>, vector<int>, ptInCircle,
Random Rect
§ ...etc Type
§ Random Maker Class

Main Framework
- TXT Parser
§ TXT File Read/Write
§ Data Parsing (like : XML Format)
[Not Yet Perfect Implemented]

Main Framework
- Math Functions
§ Distance(x1, y1, x2, y2)
§ Angle(x1, y1, x2, y2) [Radian Value]
§ Object Screen In Check
§ Pt In Rect(used winapi function)
§ Pt In Circle
§ Pt In Isometric
§ Circle In Rect (For not used Entity)
§ Circle In Circle Intersect (For not used Entity)
§ ...etc

Main Framework
- Math Functions

Engine Run Logic
•Engine Core
- Engine Core Class include some Threads for
programmer's non-sync functions
•Engine System Class
- Engine System Class is Project's Main Class that is
included Engine Initialize Progress and Engine
Boot System
•Engine Boot System
- Engine boot System Class has File System That's
working for Engine System initialize and Resource
Recognize

What is Our Project?
•Game
- Genre : Turn Based World + RTS Battle
- Resource : Used Navy field 1 Resources
- Configuration : Game + Tool [For make game data]
- Dev. Environment : Sephy Engine Based 2D PC
Game
- Dev. Period : `17.05.24 ~ 17.08.25

In Game System
Isometric Based 2D MapTool
uMapTool Video Link
https://youtu.be/P1KWafPZ1MY
Jaejun-Kim

•Isometric Based Tile System
- Isometric Tile [Cell]
- MapTool Object Layer
§ Tile
§ Object
§ Event Object
•Object
- Object is Just Visual Object
- Bbject Type
§ Island Object
§ Building Object
•Event Object
- Event Object is Something Eventable
- Collision Box
- Repair Area
- Observer Area
- Weather Fog

•MapTool Main System
- Object Control System
§ Setup Object Items
§ Remove Object Items
[ Cell(Tile) / Object / Event Object ]
- Resource Control System
§ Tile / Object Sprite Resource Load
§ Resource Interface [ UI ]
- Map System
§ Camera Control
§ Minimap Control
§ Tool Log Manager
- MapTool Control System
§ Tool Control
• Save/Load
• Reset
• Object Border Drawing Control
§ Object Detail Control
• Object Infomation View
• X, Y Position
• Free Position Mode

•MapTool Picture
Tool Control Viewer
Event Object Control
Viewer
Minimap Viewer
Log Viewer
Object Resource
Sprite Viewer
Object Detail
Control Viewer
System State Log

•MapTool Picture
- Cell Texture Change [To Select Tile] : Mouse Drag
- Camera Move : Arrow Key
- Object Setup : Mouse LButton

•Map Data Format
- TXT File String Data
- Cell Data
§ Cell Texture File Name
§ Total Cell Size : Cell X * Y
ex) 128 * 128 = 16384 Cell
- Object Data
§ Object Texture File Name
§ Object Position(X, Y)
§ Object Width, Height
- Event Object Data
§ Event Object Type
• Collision Box, Repair Area, Observer Area, Weather
§ Event Object Texture File Name
§ Event Object Position(X, Y)
§ Event Object Width, Height

•Map Data Format Picture

In Game System
Unit Balancing Test Tool
uUnitTool Video Link
https://youtu.be/WKNsiv22H1Y
Jaejun-Kim

•Unit Tool System
- What is Unit Tool?
§ Unit Tool is Battle Simulation Testing Tool. You can
check each unit's performance on your designated unit
performance for balance.
- Unit Control System
§ Unit List Viewer
§ Unit Attribute[ability] Setup
§ Make Designated Attritube Unit
§ Unit Update Controller
- Basic Tile MapSystem
§ Setup Basic Sea Tiles
§ Camera Move

•Unit [Battle Ships]
- In Game Unit Type
§ Battle Ship, Cruiser, Destroyer, Frigate, Corvette
§ Carrier [Not Implemented]
- Unit Attack Type
§ Cannon - Bullet
§ Torpedo [Not Implemented]
•Unit Attributes
- DP [Ship Health] + Max DP
- Repair Speed [Self Healing Speed]
- Engine Speed [Move Speed] + Max Speed
- Rotate Speed [Rotation Speed]
- Accelerate Speed [Accelate Speed]
- Radar Range [Ship Sight Range]
- Turret [Cannon] Include Damage Performance
- Performance [Ship Performance Ability]
- Sailor [Ship Sailor Count]
- Antiair Capacity [Antiair Turret Count]
- Antiair Range [Antiair Turret Range]
- Antiair Damage [Antiar Turret Damage]
- Phase [Ship Call Phase]
- Mass [Ship Mass]
- Evasion Radius [Ship Evasion Value]

•Unit Tool Picture
Unit List View Update Controller
Made Unit List Unit Attribute
Controller

In Game System
Battle
uBattle Video Link
https://youtu.be/wTWE4sUKa6Q
Jaejun-Kim

Battle System
•Battle System
- Battle
§ This Project's "Battle System" is always passes through
"World System". in this document, to explain "Battle
System" has what logics and how to be made.
- Battle Loading
§ Generally, "Battle System" is always started through
"Loading". when is loading, battle map data is
uploaded and each player's unit data are initialized
process.
- System Configuration
§ Battle Main System
• Camera System
• Map System
• Unit System
• Fleet System
• Sound System
• Fog System
§ Battle Result System

Battle System
•Camera System
- Camera System is managing camera position
related all Object's position.
- Minimap System
§ Minimap Interface
[Not yet perfect Implemented]
•Map System
- Map System is called when is main system
initializing, setup battle map data to screen what
are cells, objects, event objects and manage all
object's position relative with camera system.
•Unit System
- Unit System is managing all units in battle.
- Checking unit's dead or alive, making ship[called
by player], unit's position relative with camera
system, ..etc.

Battle System
•Fleet System
- Fleet system is a interface used when player want
to make some ships setup to fleet
- Fleet types are Alpha ~ Hotel [A~H] (8 slots)
- If player setup some ships to fleet, the ships would
be received buff effect.
•Sound System
- Sound system is a simple managing system for
battle background sound.
- Sound system control playing background sound
or changing sound related battle phase.
•Fog System
- Fog System is implemented for fog of war in battle.
- Fog count is just related game resolution
- Fog of war is different one of in game event
object's weather fog

Battle System
•Set up Units [Before Battle Start]
§ Before Battle start, player can set up units only phase 1
battle ships
§ Second, player can set up ships only in starting area
§ If player set up ships of phase 2 or 3, it would be
canceled when battle start
§ But player can control "Fleet Make System" for ships
of phase 2 or 3

Battle System
•Set up Units [After Battle Start]
§ Click what player want ships in list on left top interface
§ Click Mouse LButton where player want position
§ And then there is made dummy ship sprite
§ The dummy ship has spawn delay time
§ If spawn countdown finished, the ship would be created
in spawn area
§ Finally, the ship move to setup position when created

Battle System
•Fire & Bullet
- If the battle ship has turret and in sight enemy ship,
the ship would shoot bullets at once
- Each ship has designated turret data
- Each ship has turret count so fire bullets for turret
count
- the bullet's damage is designated from Turret Data

Battle System
•Damage & Effect
- All Ships taken damage following under rules
§ Miss Shot : low damage
§ Hit : high damage
§ Whether Miss or Hit ? Pixel Collision Check between
Bullet and Ship
§ Miss Shot Sprite : Water Effect
§ Hit Sprite : Explosion Effect

Battle System
•Damage Digit
- Split Damage Count To Digit
- Make Each Digit Sprite

Battle System
•Ship - Island Collision
- All Ships couldn't passed Island Object
- Exactly, All ships are checked ship's pixel whether
intersect to Collision box made from map tool every
frame time

Battle System
•Relation Ship's Radar Range and Fog of
War
- All Ships has Radar range
- this radar range means each unit's sight range
- If fog of war tile intersected player ship's radar
circle, the fog would be cleared
Blue Line -
Radar Circle

Battle System
•Observer Area Relate Fog of War
- Observer Area same work ship's radar circle
- Picture before captured area
- Picture after captured area

Battle System
•Repair Station
- Repair station give to each ship's repair speed buff
- If player capture repair area, the area given to
player ships about 120% repair speed up
- the area has buff range so ship taken buff only
near area

Battle System
•AI
- In this project, Battle AI is not implemented
- Current, Battle AI is just waiting player ships on
starting area
- We expect patrol type AI with using fleet system

Battle System
•Result System
- Result system is managing battle's result data and
throw data to World Campaign
- Result Data
§ Remain Ships
§ Battle Score [Damage Score]
Player Result Data AI Result Data

Battle System
•Recently Working Contents
- Fleet System Implement
- Patrol Type AI System
- Aircraft Implement
- Carrier Ship Implement
- Torpedo Weapon Implement
- Fog of War Sprite Implement
- Battle Random Event Weather
- Confuse State Ship Implement
- More Reality Turret Firing
ex) Sequencial Fire, More Reality Turret Fire
- bug Fix
- ...etc

Project Review
•Simple Comment [Jaejun-Kim]
- English : I will never more develop rts game!!!
- Korea : 다신 전략 게임 개발하기 싫어요...
- Review
§ 나만의 엔진을 만드는 과정에서 습득하는 지식과 늘어
나는 스킬은 확실히 프로그래밍을 계속 하게만들어주는
원동력이 되었다. 독학으로 공부하여 여기까지 달려오
는 과정에 쏟아부은 시간에 비하면 많은 결과를 내놓지
못한 것 같아 아쉬움이 많다.
혼자 제작한 자체엔진으로 게임을 하나 만들어보고자
석 달동안 열심히 공부하고 작업을 하였으나 게임은 미
완성으로 프로젝트를 종결하게 될 것 같아 아쉽다. 그러
나 2D가 아닌 3D 엔진을 만들어보고 그 엔진으로 또 다
시 새로운 게임을 제작하고 싶은 마음이 이미 나로호 마
냥 하늘높이 솟구치고 있다.
프로그래밍을 하면서 실수한 부분 또는 미흡한 부분이
수두룩하나 중요한 부분들은 지속적으로 수정해나가고
발전해 나간 것 같다. 이 문서를 확인 하신 분들께 감사
인사를 드리며 문서를 마무리 합니다.
§ 추신. 이 프로젝트에서 smart pointer를 제대로 못쓴게
엄청난 한이다. 다음 프로젝트 부터는 엄청나게 써야지..

Reference
• Book [주요 참고 서적]
- 2D Game Programming
- Game Engine Architecture
- Game Programming Pattern
• Video Link [Youtube 영상 링크]
- MapTool
§ https://youtu.be/P1KWafPZ1MY
- UnitTool
§ https://youtu.be/WKNsiv22H1Y
- Battle
§ https://youtu.be/wTWE4sUKa6Q
- Dummy Simple Battle Video
§ https://youtu.be/VTCVWAdKf-A
- Engine
§ ...
• Blog Link
- http://redforce01.tistory.com/174
• Project Github Link
- https://github.com/redforce01/SephyEngine/tree/Jaejun-Kim

Sephy engine development document

Recommended

Recommended

More Related Content

What's hot

What's hot (16)

Similar to Sephy engine development document

Similar to Sephy engine development document (20)

Recently uploaded

Recently uploaded (20)

Sephy engine development document