An open-source re-implementation of Pokémon Red

Overview

OpenPokémonRed

CI GitHub stars GitHub license

🔰 Description

🚧 WARNING: This project is unofficial!! 🚧

This project is open source re-implementation of Pokémon Red.

The ROM version is not Japanese but English.

🏜 Roadmap

This project is in the middle of development and is currently creating the underlying system part.

  • Text engine
  • Menu engine
  • Sprite engine
  • Statue screen
  • Trainer card
  • Title
  • Oak speech
  • Naming screen
  • Combat system
  • Wild pokemon battle
  • Trainer battle
  • Use item
  • PC
  • Pokecenter
  • Pokemart
  • Pokedex
  • Save function
  • Field move(Cut, Strength, Surf...)

🏞 Screenshots

Screenshots as of v0.1.0

  

  

🎡 Try

12/27: This cannot be played now! Since this repo uses Nintendo assets, I have temporarily suspended the publish of encrypted asset file. Please wait until I come up with a good solution ...

Download

Please download binary from Release page.

Build

Requirements:

  • Go 1.15
  • Windows10 or MacOS(<= Big Sur)
gh repo clone pokemium/OpenPokemonRed
cd OpenPokemonRed && make build # For Mac OS. If your OS is windows, please `make build-windows`.

💻 Key

keyboard game pad
← button
↑ button
↓ button
→ button
S A button
A B button
Enter Start button
Right shift Select button
Comments
  • Crash - unable to open music .ogg files

    Crash - unable to open music .ogg files

    I can build the project on Windows 10 via make build-windows, however, when I run the exe:

    [email protected] MINGW64 ~/git/OpenPokemonRed (master) $ ./build/windows-amd64/pokered.exe panic: runtime error: invalid memory address or nil pointer dereference [signal 0xc0000005 code=0x0 addr=0x18 pc=0x11150b7]

    goroutine 1 [running, locked to thread]: pokered/pkg/audio.newMusic(0x0, 0x0, 0x11bf183, 0xf, 0x11bbfb0, 0x8, 0x0) C:/Users/dan/git/OpenPokemonRed/pkg/audio/music.go:62 +0x57 pokered/pkg/audio.newMusicMap(0xac44) C:/Users/dan/git/OpenPokemonRed/pkg/audio/music.go:31 +0x7c pokered/pkg/audio.init() C:/Users/dan/git/OpenPokemonRed/pkg/audio/music.go:24 +0x4b

    I've looked into it and it looks like the func newMusic in music.go is crashing, probably unable to find the file? I'm not sure what the music paths represent (for example /1-00 Intro.ogg), where are this files supposed to be located? I can't find any .ogg file in the project.

    opened by stoiandan 1
  • Layer system

    Layer system

    現在のシステムでは複数枚の画面描画を再現しきれないのでレイヤーシステムを導入する

    各パッケージのVBlankではこのレイヤーにイメージをセットしていって最後にそれらを組み合わせて画面を作る

    • 最後の画像合成先をstore.TileMapにする
    • store.TileMapには最後の画像合成以外で書き込みを禁止する
    • menuのZ軸はこのレイヤーのZ軸と統合する

    現在の設計では

    type Layer struct {
    	Name  string
    	Z     int
    	Image *ebiten.Image
    }
    
    var Layers = []Layer{}
    

    こんな感じ

    Name はレイヤーの識別子とする予定

    memo 
    opened by pokemium 0
  • world

    world

    マップでの処理

    format

    PokeTraveler方式を考えたが、原作と同じ方式で良さそう

    PolishedMapを使えばそこまでDXは悪くない

    map

    • header/ マップヘッダ
    • object/ マップオブジェクト
    • wild/ 野生のポケモン
    • mapmeta/ その他のメタデータ
    • hidden/ hidden objects
    • blk/ blockdata
    memo 
    opened by pokemium 0
  • Script

    Script

    実際にエンジン部分を組み合わせてゲームを作っていく方法

    戦闘

    1. map script
    2. text engine
    3. 戦闘開始

    2 -> 3 のつなぎ目

    ショップ

    1. 売り物のlist menu
    2. 個数

    1 -> 2 のつなぎ目

    solution

    現在実行中のハンドラ関数という項目を作り、それによって個別の処理を実現していく?

    memo 
    opened by pokemium 0
  • 毎フレームの処理(Mode)

    毎フレームの処理(Mode)

    ゲームボーイと違って、vblankが終わっても元の処理に戻ることはない テキスト描画中なら次のフレームでもテキスト描画を続けるように、Overworld中なら次のフレームでもOverworld処理を続けるようにしてやる必要がある PokeTraveler同様にModeによる処理の分岐を実装してやる予定 VBlankという毎フレーム必ず実行される処理も作る予定

    Mode

    • mainモード (下記のモードを組み合わせて様々なゲーム内の処理を実現する)
    • overworld
    • text
    • アニメーション
    • menu(textに含む?)
    • ポケモン図鑑
    • A/Bボタンを押してもらうウィンドウ(ステータス,タウンマップ, Diploma)

    subMode

    textのscroll待機処理など、思った以上にloopが多く、複数のモードが必要なのではと思ってきた

    一番上の階層にモードを大量に作るのは問題があるのでsubModeを使うのが良い気がする

    その前にscrollの問題を別の手法で解決できるか考える

    memo 
    opened by pokemium 0
  • Sprite

    Sprite

    人や、ものなどのスプライト全般

    Render

    OAMシートを作ってスプライトはそこに配置していき、最後にそれをtilemapの上に描画する予定

    草むら

    草むらでは、 BG > SPR になっており草むらのタイルをスプライトのタイルの上から 下半分だけ描画する必要がある

    BG > SPR の現象は草むらだけなので草むらは特殊なタイルにして上から描画するようにする?

    テキストボックス

    テキストボックスに隠れたスプライトは非表示にしてやる必要がある

    • テキストボックス層
    • スプライト層
    • BG層

    とレイヤを分けるのがいい気がする

    API list

    • [x] UpdateSprites
    • [x] UpdatePlayerSprite
    • [x] UpdateNonPlayerSprite
    • [x] DoScriptedNPCMovement
    • [x] UpdateNPCSprite
    • [x] UpdateSpriteMovementDelay
    • [x] UpdateSpriteInWalkingAnimation
    • [x] InitializeSpriteScreenPosition
    • [x] TryWalking
    • [x] UpdateSpriteImage
    • [x] MoveSprite
    • [x] AdvancePlayerSprite
    • [x] SpriteFacingAndAnimationTable
    • [x] AnimScriptedNPCMovement
    • [x] InitializeSpriteStatus
    • [x] CheckSpriteAvailability
    • [x] MakeNPCFacePlayer
    memo 
    opened by pokemium 0
  • Data

    Data

    Data

    静的データ GB版ではROMに格納されていたデータ このパッケージは利用するだけの単方向のパッケージにする

    Dataの中に入れるのは

    • baseStats
    • mapHeaders
    • mapObjects
    • wildPokemon
    • *.asm
    • テキストデータ

    など大量のデータがあるがこれらを go のデータ構造にするか、jsonなどの汎用DSLを使うかは要検討

    goのデータ構造じゃないとシングルバイナリにできない

    constantsのデータはenumなので別ディレクトリ?

    memo 
    opened by pokemium 0
  • Text

    Text

    Text

    テキストエンジン このパッケージは単方向に利用されるだけのパッケージである必要がある

    機能

    • テキストコマンドの処理
    • 特殊文字の処理

    テキストコマンド

    TX_RAM -> "{関数名}" 事前に対象の値を返す関数をmapに登録しておき、それを実行する
    TX_LINE -> "${line}"
    TX_BLINK -> "${blink}"
    TX_ASM -> "${関数名}" 事前に関数をmapに登録しておき、それを実行する
    
    TX_SFX_ITEM_2         
    TX_SFX_KEY_ITEM       
    TX_SFX_CAUGHT_MON     
    TX_SFX_DEX_PAGE_ADDED 
    TX_CRY_NIDORINA       
    TX_CRY_PIDGEOT 
    

    特殊文字のformat

    text   EQUS "db $00," -> なし
    next   EQUS "db $4e," -> \n
    line   EQUS "db $4f," -> \n
    para   EQUS "db $51," -> \p
    cont   EQUS "db $55," -> \c
    done   EQUS "db $57"  -> \d
    prompt EQUS "db $58"  -> \▼
    page				  -> ??
    dex       			  -> ??
    

    テキストデータ

    ゲーム内で扱うテキストデータと、人間が書くテキストデータは違うフォーマットにして、内部で変換を行う

    _AgathaEndBattleText::
    	text "Oh ho!"
    	line "You're something"
    	cont "special, child!"
    	prompt
    
    var text = `
    Oh ho!
    You're something
    special, child!
    ▼` // $tOh ho!\nYou're something\nspecial, child!\▼
    
    _PewterCityPokecenterGuyText::
    	text "Yawn!"
    
    	para "When JIGGLYPUFF"
    	line "sings, #MON"
    	cont "get drowsy..."
    
    	para "...Me too..."
    	line "Snore..."
    	done
    
    var text = `
    Yawn!
    
    When JIGGLYPUFF
    sings, #MON
    get drowsy...
    
    ...Me too...
    Snore...
    ` // "Yawn!\pWhen JIGGLYPUFF\nsings, #MON\nget drowsy...\p...Me too...\nSnore..."
    
    _DexSeenOwnedText::
    	text "#DEX   Seen:@"
    	TX_NUM wDexRatingNumMonsSeen, 1, 3
    	text ""
    	line "         Owned:@"
    	TX_NUM wDexRatingNumMonsOwned, 1, 3
    	db "@"
    
    var text = `
    #DEX    Seen:${DexSeen}
    		Owned:${DexOwned}
    `
    
    memo 
    opened by pokemium 0
  • Menu

    Menu

    menu

    start menuのような具体的なmenuではなく、menuのエンジン部分

    • 通常menu
    • listmenu
    • 個数選択Menu(DisplayChooseQuantityMenu)

    関連する関数

    • DisplayListMenuID -> InitListMenuID
    • DisplayListMenuIDLoop
    • DisplayChooseQuantityMenu
    • ExitListMenu
    • PrintListMenuEntries
    • HandleMenuInput
    • PlaceMenuCursor
    • PlaceUnfilledArrowMenuCursor
    • EraseMenuCursor

    memo

    • 2択メニューは特別扱いしない
    • startmenuはmenuの一種だし、機能として独立してるのでwidget
    • InitListMenuID で listを特定の変数に入れると list menuモードになる?
    • list menuモードでは DisplayListMenuIDLoop が実行され続ける
    • menuモードでは HandleMenuInput が実行され続ける

    menuは複数存在しうるがその構造体をすべて作ってしまう?

    memo 
    opened by pokemium 0
  • Picuture

    Picuture

    format

    個人的には一つのバイナリにしたいので画像データはバイト列として抜き出す

    画像データが必要なもの

    • ポケモン(前面、背面)
    • トレーナー(デフォルメなし)
    • スプライト(人、ポケモン、...)

    タウンマップ

    • カントー地方の画像を作っておいてそれを1枚の画像として使う
    • タイルセットから形成する
    memo 
    opened by pokemium 0
  • BUG: NewLlines on windows

    BUG: NewLlines on windows

    https://github.com/pokemium/OpenPokemonRed/blob/206e9bc65856ea44934870418dd9a3cab2cd4e8d/pkg/text/preprocess.go#L9

    https://github.com/pokemium/OpenPokemonRed/blob/206e9bc65856ea44934870418dd9a3cab2cd4e8d/pkg/util/util.go#L33

    Due the the text being store in in the source file line endings are Based on the file encoding and not the os version. When compiled for The opening interaction with oak has no text and crashes due the the line not splitting and be made empty with the sub select. Pull request incoming.

    opened by Plloi 0
  • Make version a const string and remove duplicate code

    Make version a const string and remove duplicate code

    By making version a public const string, you eliminate a function call. Defaulting it to "Develop" obtains the same result as the old function call getVersion().

    opened by stoiandan 1
  • Engine

    Engine

    特殊な処理が多いのでEngineは必要な可能性が高い?

    依存関係がぐちゃぐちゃになりそうだが...

    • battle -> パッケージとして独立
    • items -> パッケージとして独立
    • menu -> widgetパッケージ
    • overworld -> パッケージとして独立
    • *.asm -> これをengineとする?

    結論 engine/*.asm の部分だけを engineにし、他はパッケージとして独立

    engine が参照するのは data のみにする?

    memo 
    opened by pokemium 0
  • Items

    Items

    items

    • inventory かばんとPCボックス
    • itemfinder ダウジングマシン
    • items アイテムを使う処理
    • tm 技マシンに関する処理

    inventory

    機能

    • インベントリのアイテムの追加・削除
    • アイテムのスワップ
    • インベントリが満タンか

    itemfinder

    ダウジングマシン

    items

    アイテムを使う処理 いろいろな上の階層のステートをいじる必要が出てくるのでこれは別パッケージにおいた方がいいかも?

    tm

    • 技マシンの価格を取得
    • ポケモンが指定した技マシンの技をすでに覚えているか -> 拡張性を考えて全ての技に変更?
    • ポケモンが技マシンの技を覚えられるかチェック
    memo 
    opened by pokemium 0
  • PokemonRed

    PokemonRed

    PokemonRed

    ポケモン赤を忠実に再現

    ただ拡張性を考えて作る

    使用技術

    MonsterEngineでの再利用性を考えて選びたい

    1. Go + ebiten
    • 使用経験がある
    • Goなのである程度のパフォーマンスが見込める
    • PokeTravelerやBoJのコードが再利用できる
    • wasm化でwebに組み込むこともできる
    1. TypeScript + React
    • Webで遊べる
    • electronでデスクトップアプリも可能
    • CSSで見た目に拘れる
    • MonsterEngineでのUI作りが楽

    結論 wasm化を考えると Go で作った方が良さそう

    memo

    • 完全再現なのでアセットの妥協はしたくない
    • ただ戦闘のアニメーションは後回しでいいかも
    • バグの再現はしない
    • マップは一枚の画像で作るのではなくタイルごとにレンダリングする
    • 図鑑番号とポケモンIDは別に定義する
    • ポケモン作成のゲームエンジンの名前は Pokemium
    memo 
    opened by pokemium 0
Releases(v0.1.0)
  • v0.1.0(Dec 25, 2020)

    12/27: This cannot be played now! Since this repo uses Nintendo assets, I have temporarily suspended the publish of encrypted asset file. Please wait until I come up with a good solution ...

    Source code(tar.gz)
    Source code(zip)
Owner
Akatsuki
!?
Akatsuki
An open source re-implementation of Diablo 2

OpenDiablo2 Join us on Discord! Development Live stream Support us on Patreon We are also working on a toolset: https://github.com/OpenDiablo2/HellSpa

OpenDiablo2 10.4k Nov 23, 2022
This project is designed to be an open source implementation for streaming desktop games using WebRTC

The aim of this project is develop a WebRTC screenshare designed for streaming video games and accepting remote inputs. There will be ansible instruct

Akilan Selvacoumar 20 Oct 6, 2022
Engo is an open-source 2D game engine written in Go.

Engo A cross-platform game engine written in Go following an interpretation of the Entity Component System paradigm. Engo is currently compilable for

Engo 1.6k Nov 14, 2022
Open source of the build infrastructure used by Stadia Games & Entertainment

SG&E Monorepo This repository contains the open sourcing of the infrastructure developed by Stadia Games & Entertainment (SG&E) to run its operations.

Google 58 Nov 17, 2022
Blunder is an open-source UCI compatible chess engine.

A UCI compatible chess engine written in Golang

Christian Dean 198 Nov 2, 2022
Go implementation of the A* search algorithm

go-astar A* pathfinding implementation for Go The A* pathfinding algorithm is a pathfinding algorithm noted for its performance and accuracy and is co

Michael Alexander 530 Nov 18, 2022
An implementation of the popular game Codenames created with Go and React.

OpenCodenames A real-time implementation of Codenames created with React/TypeScript and Golang. You can play the game here! Installation Stack: React

null 29 Aug 8, 2021
⛏ 🐹 Minecraft Protocol implementation in Go

illustration by @talentlessguy Install Go 1.16.x is required to use this library go get github.com/BRA1L0R/go-mcproto Opening a connection client := m

Pietro Tamilia 31 Sep 20, 2022
A go implementation of Conway's game of life

go-life A go implementation of Conway's game of life. The program takes input from stdin. It's recommended to use it as cat input.txt | go-life with i

Maxim 0 Oct 20, 2021
Go implementation of 2048 game

Go implementation of 2048 game

Kaushal Shah 0 Oct 21, 2021
snake game implementation using 2d array in Go

Snake Game Implementation Snake game implementation in Go using a 2-dimensional array. Demo Install download the package git clone https://github.com/

Iss Meftah 10 May 14, 2022
a Go implementation of the game of Briscola

BrisGolang BrisGolang is a Go implementation of the game of briscola using the WebSocket protocol for client/server communication. Usage You can play

Calogero Miraglia 0 Sep 15, 2022
Minecraft server implementation using Golang

Deepslate Deepslate is a Minecraft server implementation in Go. Deepslate if WIP and currently not available for installation Goals First implementati

virusbear 1 Nov 19, 2021
Implementation of a popular graphics benchmark written on Ebiten.

Ebiten Bunny Mark This is an implementation of the popular graphics benchmark written on Ebiten. The initial benchmark was created by Ian Lobb (code)

Artem Sedykh 16 Nov 5, 2022
An implementation of Conway's Game of Life.

Conway's Game of Life From Wikipedia, the free encyclopedia: The Game of Life, also known simply as Life, is a cellular automaton devised by the Briti

Erik Hovsepyan 1 Mar 16, 2022
red-tldr is a lightweight text search tool, which is used to help red team staff quickly find the commands and key points they want to execute, so it is more suitable for use by red team personnel with certain experience.

Red Team TL;DR English | 中文简体 What is Red Team TL;DR ? red-tldr is a lightweight text search tool, which is used to help red team staff quickly find t

倾旋 181 Nov 15, 2022
Command line tool for searching Pokémon information

Pokesearch Command line tool for searching Pokemon information. Work in progress To-do Usage details Finish README.md Research release details Command

Adory Vo 0 Jan 27, 2022
Pokemon Unite scoreboard HUD and extra tools running over captured game feeds using the OpenCV video processing API and Client/Server architecture.

unite Pokemon Unite scoreboard HUD and extra tools running over captured game feeds using the OpenCV video processing API. Client (OBS Live) Server Ar

pidgy 5 Nov 7, 2022
A Pokédex in the form of a REST API that returns Pokémon information.

Pokédex API A Pokédex in the form of a REST API that returns Pokémon information. The API has two main endpoints: Return basic Pokémon information. Re

Imogen Kraak 0 Jan 13, 2022
SigNoz helps developers monitor their applications & troubleshoot problems, an open-source alternative to DataDog, NewRelic, etc. 🔥 🖥. 👉 Open source Application Performance Monitoring (APM) & Observability tool

Monitor your applications and troubleshoot problems in your deployed applications, an open-source alternative to DataDog, New Relic, etc. Documentatio

SigNoz 4.7k Sep 24, 2021