parin README

README проекта с github.com/Kapendev/parin. Одним файлом markdown: README.md.

Parin

A delightfully simple 2D game engine for the D programming language. It's easy to set up, hackable, and comes with the essentials built in.

Parin demo

Why Parin

Parin sits somewhere between a small library like raylib and a big engine like Godot. It offers more direction than small libraries, but far less overhead than big engines. Its main ideas are:

Basic code example:

import parin;

// Called every frame while the game is running.
bool hello(float dt) {
    lockResolution(320, 180);
    drawText("Helloo!!!", mouse);
    return false;
}

// Creates a main function that calls the given function.
mixin runDemo!hello;

Major Features

Quick Start

This section shows how to install Parin using DUB. Create a new folder and run the following commands inside it:

dub init -t parin
dub run

If everything is set up correctly, a window will appear showing a simple message.

Available starting templates:

dub init -t parin -- basic
dub init -t parin -- entity

Install Without DUB

Create a new folder and run the following to...

  1. Prepare the folder:

    git clone --depth 1 https://github.com/Kapendev/parin parin_package
    ./parin_package/scripts/prepare
    # Or: .\parin_package\scripts\prepare.bat
    
  2. Run the project:

    ./parin_package/scripts/run
    # Or: .\parin_package\scripts\run.bat
    # Or: ./parin_package/scripts/run ldc2 macos
    # Or: ./parin_package/scripts/run opend
    

Required Libraries on Linux

Some libraries for sound, graphics, and input handling are required before using Parin on Linux. Below are installation commands for some Linux distributions.

Ubuntu:

sudo apt install libasound2-dev libx11-dev libxrandr-dev libxi-dev libgl1-mesa-dev libglu1-mesa-dev libxcursor-dev libxinerama-dev libwayland-dev libxkbcommon-dev

Fedora:

sudo dnf install alsa-lib-devel mesa-libGL-devel libX11-devel libXrandr-devel libXi-devel libXcursor-devel libXinerama-devel libatomic

Arch:

sudo pacman -S alsa-lib mesa libx11 libxrandr libxi libxcursor libxinerama

Void:

sudo xbps-install make alsa-lib-devel libglvnd-devel libX11-devel libXrandr-devel libXi-devel libXcursor-devel libXinerama-devel mesa MesaLib-devel

Documentation

Start with the examples folder or the cheatsheet for a quick overview. For more details, see the tour page or dlang.uk/parin. The DDOX documentation engine can also be used to create an overview with:

git clone --depth=1 https://github.com/Kapendev/parin parin_package
cd parin_package
dub run -b ddox

Articles:

Videos:

Web Builds

Parin includes a build script for the web in the packages folder. Building for the web requires:

Running the script with DUB:

dub run parin:web

Without DUB:

./parin_package/scripts/web
# Or: .\parin_package\scripts\web.bat

API:

Usage:
  dub run parin:web -- [flags] [libs]
Flags:
  -help     Show this.
  -betterc  Use the `-betterC` flag.
  -release  Use the `-release` flag.
  -build    Avoid emrun after a successful build.
Libs:
  Any non-flag argument is linked as an extra library.
  Example: dub run parin:web -- web/libbox2d.a

Uploading to itch.io:

  1. Open the web folder.
  2. Select the index.* files and add them to a ZIP file.
  3. Go to itch.io and create a new project.
  4. Under "Kind of project", choose "HTML."
  5. Upload the ZIP file and enable the option "This file will be played in the browser."
  6. Ignore everything in "Frame options" except "Fullscreen button."

Ideas

If you notice anything missing, feel free to open an issue! You can also share things in the GitHub discussions. Most ideas are welcome, except hot reloading.

Small extras that don't belong in the core can live in the addons folder as single-file D libraries. Open a PR and add the file there.

Frequently Asked Questions

Is there a list of games made with Parin?

Does Parin have a scene or entity system?

No. However, there are examples of how to build them using the Union type in the examples folder:

Does Parin have a scripting language?

No. The following projects might be useful:

Any other libraries that I can use?

Can I release on Steam or make multiplayer games?

Yes. Parin includes bindings for Steamworks and ENet in parin.bindings. See the integration examples. The binaries themselves are not included, so they need to be downloaded or built and linked separately.

For Zed, install the Path Server extension to get autocomplete for paths inside the assets folder.

How can I load an asset outside of the assets folder?

Call setIsUsingAssetsPath(false) to disable the default behavior. Or setAssetsPath(assetsPath.pathDirName) to load from the executable's folder.

How can I hot reload assets or code?

Hot reloading is not supported out of the box because I (Kapendev) don't care about that feature. The arsd libraries may help.

How can I test dialogue scripts?

With Rin, a small tool that runs dialogue scripts in the terminal. See packages/rin for how to use it.

Are the Parin assets free to use?

Yes. Be sure to check the associated README for any licensing notes.

Is Parin a raylib wrapper?

No. Raylib is one of its backends. A custom backend is being worked on, but it's still experimental. Contributions are welcome.

Can I use Parin for HD games?

Yes. Use Filter.linear for smooth textures, or Filter.trilinear if they are often drawn much smaller than their real size. See the mipmaps example.

parin (Kapendev/parin)

Ищем в базе…

148 ·GitHub
Что это такое?Parin — это лёгкий 2D-движок для игр на языке программирования D, который легко настроить, его можно переделывать под себя, и он уже включает всё необходимое: анимацию, поиск пути и эффект тряски экрана.
Parin — это просто обёртка над raylib или что-то большее?Нет, Parin — это самостоятельный движок, который использует raylib как один из своих бэкендов; собственный бэкенд находится в разработке, но пока экспериментальный.
Как запустить проект на Parin?Установите его через DUB: создайте новую папку и выполните в ней команды Quick Start, чтобы сгенерировать рабочий стартовый шаблон с видимым окном.
Что нужно установить перед работой с Parin на Linux или для сборки под веб?На Linux нужно установить несколько библиотек для звука, графики и обработки ввода (команды установки приведены для Ubuntu, Fedora, Arch и Void). Для сборки под веб дополнительно нужны LDC и Emscripten (рекомендуемая версия 4.0.23).
Есть ли в Parin встроенная система сцен и сущностей или скриптовый язык?Нет ни на то, ни на другое: Parin не включает систему сцен и сущностей (хотя в примерах показано, как её построить с помощью типа Union), и у него нет встроенного скриптового языка, но вместо него можно использовать сторонние D-библиотеки, например wren-port или arsd.script.
Под какие платформы можно собирать игры на Parin?Игры на Parin можно собирать для Web, Windows, Linux и macOS.
Можно ли выпустить игру на Parin в Steam или добавить мультиплеер?Да, Parin включает D-привязки для Steamworks и ENet в parin.bindings, но нативные бинарники всё равно нужно скачать или собрать самостоятельно.
Поддерживает ли Parin горячую перезагрузку ресурсов или кода?Нет, горячая перезагрузка намеренно не включена, так как автор не считает эту функцию приоритетной; если она нужна, могут помочь библиотеки arsd.
Какие инструменты автор рекомендует для создания игр на Parin?Редактор — Zed (с расширением Path Server для автодополнения путей к ресурсам), уровни — Tiled, графика — Pixelorama или GIMP, звуковые эффекты — Bfxr/Jfxr, музыка — MilkyTracker.
Что такое Joka?Joka — портативная служебная библиотека, на которой построена большая часть Parin; её можно использовать отдельно от Parin, например напрямую с raylib.
Какие есть похожие проекты?ebiten, bones, GDevelop, ArcadeMaker, MonoGame, project-hedra, libgdx, raylib
Автор
Kapendev
Размер
7.1 MB
Звёзды
148
Обновлён
КоммитNov 03
Возраст
2 г
Коммиты · 90 дней