From f30c4005d4fc2dbcfdb562f060c5c95d78432d80 Mon Sep 17 00:00:00 2001 From: Yuki Kitagawa Date: Mon, 21 Oct 2024 22:21:59 +0800 Subject: [PATCH] Initial project configurations --- .addons/imgui | 1 + .addons/imgui-godot | 1 + .addons/imrp | 1 + .gitattributes | 8 + .gitignore | 488 +++++++++++++++++++++++++++++++++++++++++ Quadratic.Carto.csproj | 18 ++ Quadratic.Carto.sln | 22 ++ addons.jsonc | 25 +++ addons/.editorconfig | 12 + docs/.gitkeep | 0 gamedata/readme.md | 3 + project.godot | 11 +- readme.md | 39 ++++ res/readme.md | 3 + res/scene/test.tscn | 6 + src/Hello.cs | 11 + src/readme.md | 3 + 17 files changed, 651 insertions(+), 1 deletion(-) create mode 160000 .addons/imgui create mode 160000 .addons/imgui-godot create mode 160000 .addons/imrp create mode 100644 Quadratic.Carto.csproj create mode 100644 Quadratic.Carto.sln create mode 100644 addons.jsonc create mode 100644 addons/.editorconfig create mode 100644 docs/.gitkeep create mode 100644 gamedata/readme.md create mode 100644 readme.md create mode 100644 res/readme.md create mode 100644 res/scene/test.tscn create mode 100644 src/Hello.cs create mode 100644 src/readme.md diff --git a/.addons/imgui b/.addons/imgui new file mode 160000 index 0000000..13118d6 --- /dev/null +++ b/.addons/imgui @@ -0,0 +1 @@ +Subproject commit 13118d6b906435e3d97fe2a1d90a501d4f60c99a diff --git a/.addons/imgui-godot b/.addons/imgui-godot new file mode 160000 index 0000000..13118d6 --- /dev/null +++ b/.addons/imgui-godot @@ -0,0 +1 @@ +Subproject commit 13118d6b906435e3d97fe2a1d90a501d4f60c99a diff --git a/.addons/imrp b/.addons/imrp new file mode 160000 index 0000000..1f0f030 --- /dev/null +++ b/.addons/imrp @@ -0,0 +1 @@ +Subproject commit 1f0f030b5bc30b8ff8463f049771aa782d248efe diff --git a/.gitattributes b/.gitattributes index 8ad74f7..b20ad5d 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,10 @@ # Normalize EOL for all files that Git considers text files. * text=auto eol=lf +*.jpg filter=lfs diff=lfs merge=lfs -text +*.obj filter=lfs diff=lfs merge=lfs -text +*.fbx filter=lfs diff=lfs merge=lfs -text +*.gltf filter=lfs diff=lfs merge=lfs -text +*.mp3 filter=lfs diff=lfs merge=lfs -text +*.wav filter=lfs diff=lfs merge=lfs -text +*.flac filter=lfs diff=lfs merge=lfs -text +*.png filter=lfs diff=lfs merge=lfs -text diff --git a/.gitignore b/.gitignore index 0af181c..160d8b8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,491 @@ +addons/* +!addons/.editorconfig # Godot 4+ specific ignores .godot/ /android/ + + +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from `dotnet new gitignore` + +# dotenv files +.env + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.tlog +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio 6 auto-generated project file (contains which files were open etc.) +*.vbp + +# Visual Studio 6 workspace and project file (working project files containing files to include in project) +*.dsw +*.dsp + +# Visual Studio 6 technical files +*.ncb +*.aps + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# Visual Studio History (VSHistory) files +.vshistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# Windows Installer files from build outputs +*.cab +*.msi +*.msix +*.msm +*.msp + +# JetBrains Rider +*.sln.iml +.idea + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# Vim temporary swap files +*.swp diff --git a/Quadratic.Carto.csproj b/Quadratic.Carto.csproj new file mode 100644 index 0000000..9502746 --- /dev/null +++ b/Quadratic.Carto.csproj @@ -0,0 +1,18 @@ + + + + + + + + + net8.0 + true + Quadratic.Carto + enable + true + + + $(DefaultItemExcludes);lib\** + + diff --git a/Quadratic.Carto.sln b/Quadratic.Carto.sln new file mode 100644 index 0000000..4e653e1 --- /dev/null +++ b/Quadratic.Carto.sln @@ -0,0 +1,22 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Quadratic.Carto", "Quadratic.Carto.csproj", "{48CA7EED-7AFB-49F8-8730-73DBFDFA0831}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {48CA7EED-7AFB-49F8-8730-73DBFDFA0831}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {48CA7EED-7AFB-49F8-8730-73DBFDFA0831}.Debug|Any CPU.Build.0 = Debug|Any CPU + {48CA7EED-7AFB-49F8-8730-73DBFDFA0831}.Release|Any CPU.ActiveCfg = Debug|Any CPU + {48CA7EED-7AFB-49F8-8730-73DBFDFA0831}.Release|Any CPU.Build.0 = Debug|Any CPU + EndGlobalSection +EndGlobal diff --git a/addons.jsonc b/addons.jsonc new file mode 100644 index 0000000..32ae889 --- /dev/null +++ b/addons.jsonc @@ -0,0 +1,25 @@ +// Godot addons configuration file for use with the GodotEnv tool. +// See https://github.com/chickensoft-games/GodotEnv for more info. +// -------------------------------------------------------------------- // +// Note: this is a JSONC file, so you can use comments! +// If using Rider, see https://youtrack.jetbrains.com/issue/RIDER-41716 +// for any issues with JSONC. +// -------------------------------------------------------------------- // +{ + "$schema": "https://chickensoft.games/schemas/addons.schema.json", + // "path": "addons", // default + // "cache": ".addons", // default + "addons": { + "imrp": { // name must match the folder name in the repository + "url": "https://github.com/MakovWait/improved_resource_picker", + // "source": "remote", // default + // "checkout": "main", // default + "subfolder": "addons/imrp" + }, + "imgui-godot": { + "url": "https://github.com/pkdawson/imgui-godot", + "checkout": "6.x", + "subfolder": "addons/imgui-godot" + } + } +} diff --git a/addons/.editorconfig b/addons/.editorconfig new file mode 100644 index 0000000..d30b5ec --- /dev/null +++ b/addons/.editorconfig @@ -0,0 +1,12 @@ +# Editor configs in nested directories override those in parent directories +# for the directory in which they are placed. +# +# This editor config prevents the code editor from analyzing C# files which +# belong to addons. +# +# Ignoring C# addon scripts is generally preferable, since C# can be coded +# in a variety of ways that may or may not trigger warnings based on your +# own editorconfig or IDE settings. + +[*.cs] +generated_code = true \ No newline at end of file diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/gamedata/readme.md b/gamedata/readme.md new file mode 100644 index 0000000..3d70180 --- /dev/null +++ b/gamedata/readme.md @@ -0,0 +1,3 @@ +# GameData + +This folder contains resource files to be placed *alongside* the final executable, for easier resource management. diff --git a/project.godot b/project.godot index f42be2e..2d6fe1e 100644 --- a/project.godot +++ b/project.godot @@ -11,9 +11,18 @@ config_version=5 [application] config/name="The Carto Program Revive" -config/features=PackedStringArray("4.3", "Forward Plus") +run/main_scene="res://res/scene/test.tscn" +config/features=PackedStringArray("4.3", "C#", "Forward Plus") config/icon="res://icon.svg" +[autoload] + +ImGuiRoot="*res://addons/imgui-godot/data/ImGuiRoot.tscn" + [dotnet] project/assembly_name="The Carto Program Revive" + +[editor_plugins] + +enabled=PackedStringArray("res://addons/imgui-godot/plugin.cfg", "res://addons/imrp/plugin.cfg") diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..041a322 --- /dev/null +++ b/readme.md @@ -0,0 +1,39 @@ +# The Carto Program (Revive) + +This repository contains the source code Carto, using the [Godot game engine][godot]. + +[godot]: https://godotengine.org + +## Developing + +You would need the following programs installed in your machine to develop Carto: + +- [Godot 4.3][godotdownload] with DotNet support. +- The [GodotEnv][godotenv] addon package manager from ChickenSoft. +- DotNet 8+ SDK. + +[godotdownload]: https://godotengine.org/download/archive/4.3.0/ +[godotenv]: https://github.com/chickensoft-games/GodotEnv + +### Preparing the developing environment + +After cloning the repository, install the addons with + +```sh +godotenv addons install +``` + +### Building + +Building Carto is trivial: + +1. Build/export the project of the corresponding target with Godot's built-in export menu. +2. Copy the `gamedata` folder to the target directory, next to the executable. + +## License + +The codebase will probably be published under the [Mozilla Public License, version 2.0][mpl20]. Some assets may have a more permissive license. + +Copyleft (ɔ) Quadratic Dream & other Carto contributors. + +[mpl20]: https://www.mozilla.org/en-US/MPL/2.0/ diff --git a/res/readme.md b/res/readme.md new file mode 100644 index 0000000..668c73c --- /dev/null +++ b/res/readme.md @@ -0,0 +1,3 @@ +# Resource files + +Put models, textures, and all other resources here. diff --git a/res/scene/test.tscn b/res/scene/test.tscn new file mode 100644 index 0000000..b46541d --- /dev/null +++ b/res/scene/test.tscn @@ -0,0 +1,6 @@ +[gd_scene load_steps=2 format=3 uid="uid://tht1tf5iq6lw"] + +[ext_resource type="Script" path="res://src/Hello.cs" id="1_ex5yf"] + +[node name="Node3D" type="Node3D"] +script = ExtResource("1_ex5yf") diff --git a/src/Hello.cs b/src/Hello.cs new file mode 100644 index 0000000..b4073d2 --- /dev/null +++ b/src/Hello.cs @@ -0,0 +1,11 @@ +using Godot; + +namespace Quadratic.Carto; + +public partial class Hello : Node +{ + public override void _Ready() + { + GD.Print("Hello, C# World!"); + } +} diff --git a/src/readme.md b/src/readme.md new file mode 100644 index 0000000..7c118d8 --- /dev/null +++ b/src/readme.md @@ -0,0 +1,3 @@ +# Source code + +Put all sources here