cafkafk/nixpkgs
cafkafk/nixpkgs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2
nixpkgs/pkgs/games/blightmud/default.nix

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

70 lines
2 KiB
Nix
Raw Normal View History

blightmud: apply nixpkgs-format For consistency, this commit runs the Blightmud derivation through `nixpkgs-format`.
2022-10-05 02:32:06 +02:00
{ stdenv
, lib
, fetchFromGitHub
, rustPlatform
, pkg-config
, alsa-lib
, openssl
, withTTS ? false
, speechd
}:
blightmud: init at 3.5.0 Blightmud is a terminal client for connecting to Multi User Dungeon (MUD) games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab completion, text searching and a split view for scrolling. Blightmud can be customized with Lua scripting for aliases, triggers, timers, customized status bars, and more. Blightmud supports several accessibility features including an optional built-in text-to-speech engine and a screen reader friendly mode. For nixpkgs it is largely a standard derivation for a rust project using `rustPlatform.buildRustPackage`. There is some customization required for the optional text-to-speech (TTS) engine support. In this case the derivation must also set the `LIBCLANG_PATH` and customize `BINDGEN_EXTRA_CLANG_ARGS` in order for a required crate to be able to `rust-bindgen` the `libspeechd` dependency it wraps. Lastly the derivation has to skip some integration-style tests that don't play nicely with the nixpkgs build environment - the majority of unit tests work so they are left running in the check phase. Since the TTS support brings in heavy dependencies, but is a useful accessibility feature, the Blightmud derivation is added to `all-packages.nix` twice: 1. the `blightmud` attribute builds a configuration without TTS support. 2. the `blightmud-tts` attribute builds a configuration _with_ TTS support. The new Blightmud derivation is placed in `pkgs/games/blightmud/` following the precedent set by another packaged GUI-based MUD client, `mudlet` with `pkgs/games/mudlet/`.
2022-01-08 18:03:58 +01:00
rustPlatform.buildRustPackage rec {
pname = "blightmud";
blightmud: 5.2.0 -> 5.3.0 Updates Blightmud from v5.2.0 to v5.3.0. Requires adding one additional ignored test that fails in the isolated Nix build environment. See the upstream release notes [0] for more information. [0]: https://github.com/Blightmud/Blightmud/releases/tag/v5.3.0
2023-09-30 16:37:32 +02:00
version = "5.3.0";
blightmud: init at 3.5.0 Blightmud is a terminal client for connecting to Multi User Dungeon (MUD) games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab completion, text searching and a split view for scrolling. Blightmud can be customized with Lua scripting for aliases, triggers, timers, customized status bars, and more. Blightmud supports several accessibility features including an optional built-in text-to-speech engine and a screen reader friendly mode. For nixpkgs it is largely a standard derivation for a rust project using `rustPlatform.buildRustPackage`. There is some customization required for the optional text-to-speech (TTS) engine support. In this case the derivation must also set the `LIBCLANG_PATH` and customize `BINDGEN_EXTRA_CLANG_ARGS` in order for a required crate to be able to `rust-bindgen` the `libspeechd` dependency it wraps. Lastly the derivation has to skip some integration-style tests that don't play nicely with the nixpkgs build environment - the majority of unit tests work so they are left running in the check phase. Since the TTS support brings in heavy dependencies, but is a useful accessibility feature, the Blightmud derivation is added to `all-packages.nix` twice: 1. the `blightmud` attribute builds a configuration without TTS support. 2. the `blightmud-tts` attribute builds a configuration _with_ TTS support. The new Blightmud derivation is placed in `pkgs/games/blightmud/` following the precedent set by another packaged GUI-based MUD client, `mudlet` with `pkgs/games/mudlet/`.
2022-01-08 18:03:58 +01:00
src = fetchFromGitHub {
owner = pname;
repo = pname;
rev = "v${version}";
blightmud: 5.2.0 -> 5.3.0 Updates Blightmud from v5.2.0 to v5.3.0. Requires adding one additional ignored test that fails in the isolated Nix build environment. See the upstream release notes [0] for more information. [0]: https://github.com/Blightmud/Blightmud/releases/tag/v5.3.0
2023-09-30 16:37:32 +02:00
sha256 = "sha256-e9Uo0IJYL9/6/nNL27zfUYnsTwDaOJOcR2CY6t++jDE=";
blightmud: init at 3.5.0 Blightmud is a terminal client for connecting to Multi User Dungeon (MUD) games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab completion, text searching and a split view for scrolling. Blightmud can be customized with Lua scripting for aliases, triggers, timers, customized status bars, and more. Blightmud supports several accessibility features including an optional built-in text-to-speech engine and a screen reader friendly mode. For nixpkgs it is largely a standard derivation for a rust project using `rustPlatform.buildRustPackage`. There is some customization required for the optional text-to-speech (TTS) engine support. In this case the derivation must also set the `LIBCLANG_PATH` and customize `BINDGEN_EXTRA_CLANG_ARGS` in order for a required crate to be able to `rust-bindgen` the `libspeechd` dependency it wraps. Lastly the derivation has to skip some integration-style tests that don't play nicely with the nixpkgs build environment - the majority of unit tests work so they are left running in the check phase. Since the TTS support brings in heavy dependencies, but is a useful accessibility feature, the Blightmud derivation is added to `all-packages.nix` twice: 1. the `blightmud` attribute builds a configuration without TTS support. 2. the `blightmud-tts` attribute builds a configuration _with_ TTS support. The new Blightmud derivation is placed in `pkgs/games/blightmud/` following the precedent set by another packaged GUI-based MUD client, `mudlet` with `pkgs/games/mudlet/`.
2022-01-08 18:03:58 +01:00
};
blightmud: 5.2.0 -> 5.3.0 Updates Blightmud from v5.2.0 to v5.3.0. Requires adding one additional ignored test that fails in the isolated Nix build environment. See the upstream release notes [0] for more information. [0]: https://github.com/Blightmud/Blightmud/releases/tag/v5.3.0
2023-09-30 16:37:32 +02:00
cargoHash = "sha256-QSgTpmSojZrwZ0RsUL6c2xO310RZX3gkyGl6oNf6pYI=";
blightmud: init at 3.5.0 Blightmud is a terminal client for connecting to Multi User Dungeon (MUD) games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab completion, text searching and a split view for scrolling. Blightmud can be customized with Lua scripting for aliases, triggers, timers, customized status bars, and more. Blightmud supports several accessibility features including an optional built-in text-to-speech engine and a screen reader friendly mode. For nixpkgs it is largely a standard derivation for a rust project using `rustPlatform.buildRustPackage`. There is some customization required for the optional text-to-speech (TTS) engine support. In this case the derivation must also set the `LIBCLANG_PATH` and customize `BINDGEN_EXTRA_CLANG_ARGS` in order for a required crate to be able to `rust-bindgen` the `libspeechd` dependency it wraps. Lastly the derivation has to skip some integration-style tests that don't play nicely with the nixpkgs build environment - the majority of unit tests work so they are left running in the check phase. Since the TTS support brings in heavy dependencies, but is a useful accessibility feature, the Blightmud derivation is added to `all-packages.nix` twice: 1. the `blightmud` attribute builds a configuration without TTS support. 2. the `blightmud-tts` attribute builds a configuration _with_ TTS support. The new Blightmud derivation is placed in `pkgs/games/blightmud/` following the precedent set by another packaged GUI-based MUD client, `mudlet` with `pkgs/games/mudlet/`.
2022-01-08 18:03:58 +01:00
buildFeatures = lib.optional withTTS "tts";
blightmud: use rustPlatform.bindgenHook By using `rustPlatform.bindgenHook` as a `nativeBuildInput` the Blightmud derivation's custom LIBCLANG_PATH and preBuild step can be removed outright. See the languages frameworks Rust hooks docs[0] for more information. [0]: https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/rust.section.md#hooks-hooks
2022-10-05 02:26:06 +02:00
nativeBuildInputs = [ pkg-config rustPlatform.bindgenHook ];
blightmud: init at 3.5.0 Blightmud is a terminal client for connecting to Multi User Dungeon (MUD) games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab completion, text searching and a split view for scrolling. Blightmud can be customized with Lua scripting for aliases, triggers, timers, customized status bars, and more. Blightmud supports several accessibility features including an optional built-in text-to-speech engine and a screen reader friendly mode. For nixpkgs it is largely a standard derivation for a rust project using `rustPlatform.buildRustPackage`. There is some customization required for the optional text-to-speech (TTS) engine support. In this case the derivation must also set the `LIBCLANG_PATH` and customize `BINDGEN_EXTRA_CLANG_ARGS` in order for a required crate to be able to `rust-bindgen` the `libspeechd` dependency it wraps. Lastly the derivation has to skip some integration-style tests that don't play nicely with the nixpkgs build environment - the majority of unit tests work so they are left running in the check phase. Since the TTS support brings in heavy dependencies, but is a useful accessibility feature, the Blightmud derivation is added to `all-packages.nix` twice: 1. the `blightmud` attribute builds a configuration without TTS support. 2. the `blightmud-tts` attribute builds a configuration _with_ TTS support. The new Blightmud derivation is placed in `pkgs/games/blightmud/` following the precedent set by another packaged GUI-based MUD client, `mudlet` with `pkgs/games/mudlet/`.
2022-01-08 18:03:58 +01:00
treewide: optional -> optionals where the argument is a list the argument to optional should not be list
2022-10-06 18:38:53 +02:00
buildInputs = [ alsa-lib openssl ] ++ lib.optionals withTTS [ speechd ];
blightmud: init at 3.5.0 Blightmud is a terminal client for connecting to Multi User Dungeon (MUD) games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab completion, text searching and a split view for scrolling. Blightmud can be customized with Lua scripting for aliases, triggers, timers, customized status bars, and more. Blightmud supports several accessibility features including an optional built-in text-to-speech engine and a screen reader friendly mode. For nixpkgs it is largely a standard derivation for a rust project using `rustPlatform.buildRustPackage`. There is some customization required for the optional text-to-speech (TTS) engine support. In this case the derivation must also set the `LIBCLANG_PATH` and customize `BINDGEN_EXTRA_CLANG_ARGS` in order for a required crate to be able to `rust-bindgen` the `libspeechd` dependency it wraps. Lastly the derivation has to skip some integration-style tests that don't play nicely with the nixpkgs build environment - the majority of unit tests work so they are left running in the check phase. Since the TTS support brings in heavy dependencies, but is a useful accessibility feature, the Blightmud derivation is added to `all-packages.nix` twice: 1. the `blightmud` attribute builds a configuration without TTS support. 2. the `blightmud-tts` attribute builds a configuration _with_ TTS support. The new Blightmud derivation is placed in `pkgs/games/blightmud/` following the precedent set by another packaged GUI-based MUD client, `mudlet` with `pkgs/games/mudlet/`.
2022-01-08 18:03:58 +01:00
blightmud: apply nixpkgs-format For consistency, this commit runs the Blightmud derivation through `nixpkgs-format`.
2022-10-05 02:32:06 +02:00
checkFlags =
let
# Most of Blightmud's unit tests pass without trouble in the isolated
# Nixpkgs build env. The following tests need to be skipped.
skipList = [
"test_connect"
"test_gmcp_negotiation"
"test_ttype_negotiation"
"test_reconnect"
"test_is_connected"
"test_mud"
"test_server"
"test_lua_script"
"timer_test"
"validate_assertion_fail"
blightmud: 5.2.0 -> 5.3.0 Updates Blightmud from v5.2.0 to v5.3.0. Requires adding one additional ignored test that fails in the isolated Nix build environment. See the upstream release notes [0] for more information. [0]: https://github.com/Blightmud/Blightmud/releases/tag/v5.3.0
2023-09-30 16:37:32 +02:00
"regex_smoke_test"
blightmud: apply nixpkgs-format For consistency, this commit runs the Blightmud derivation through `nixpkgs-format`.
2022-10-05 02:32:06 +02:00
];
skipFlag = test: "--skip " + test;
in
builtins.concatStringsSep " " (builtins.map skipFlag skipList);
blightmud: init at 3.5.0 Blightmud is a terminal client for connecting to Multi User Dungeon (MUD) games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab completion, text searching and a split view for scrolling. Blightmud can be customized with Lua scripting for aliases, triggers, timers, customized status bars, and more. Blightmud supports several accessibility features including an optional built-in text-to-speech engine and a screen reader friendly mode. For nixpkgs it is largely a standard derivation for a rust project using `rustPlatform.buildRustPackage`. There is some customization required for the optional text-to-speech (TTS) engine support. In this case the derivation must also set the `LIBCLANG_PATH` and customize `BINDGEN_EXTRA_CLANG_ARGS` in order for a required crate to be able to `rust-bindgen` the `libspeechd` dependency it wraps. Lastly the derivation has to skip some integration-style tests that don't play nicely with the nixpkgs build environment - the majority of unit tests work so they are left running in the check phase. Since the TTS support brings in heavy dependencies, but is a useful accessibility feature, the Blightmud derivation is added to `all-packages.nix` twice: 1. the `blightmud` attribute builds a configuration without TTS support. 2. the `blightmud-tts` attribute builds a configuration _with_ TTS support. The new Blightmud derivation is placed in `pkgs/games/blightmud/` following the precedent set by another packaged GUI-based MUD client, `mudlet` with `pkgs/games/mudlet/`.
2022-01-08 18:03:58 +01:00
meta = with lib; {
description = "A terminal MUD client written in Rust";
treewide: add meta.mainProgram to packages with a single binary The nixpkgs-unstable channel's programs.sqlite was used to identify packages producing exactly one binary, and these automatically added to their package definitions wherever possible.
2024-03-19 03:14:51 +01:00
mainProgram = "blightmud";
blightmud: init at 3.5.0 Blightmud is a terminal client for connecting to Multi User Dungeon (MUD) games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab completion, text searching and a split view for scrolling. Blightmud can be customized with Lua scripting for aliases, triggers, timers, customized status bars, and more. Blightmud supports several accessibility features including an optional built-in text-to-speech engine and a screen reader friendly mode. For nixpkgs it is largely a standard derivation for a rust project using `rustPlatform.buildRustPackage`. There is some customization required for the optional text-to-speech (TTS) engine support. In this case the derivation must also set the `LIBCLANG_PATH` and customize `BINDGEN_EXTRA_CLANG_ARGS` in order for a required crate to be able to `rust-bindgen` the `libspeechd` dependency it wraps. Lastly the derivation has to skip some integration-style tests that don't play nicely with the nixpkgs build environment - the majority of unit tests work so they are left running in the check phase. Since the TTS support brings in heavy dependencies, but is a useful accessibility feature, the Blightmud derivation is added to `all-packages.nix` twice: 1. the `blightmud` attribute builds a configuration without TTS support. 2. the `blightmud-tts` attribute builds a configuration _with_ TTS support. The new Blightmud derivation is placed in `pkgs/games/blightmud/` following the precedent set by another packaged GUI-based MUD client, `mudlet` with `pkgs/games/mudlet/`.
2022-01-08 18:03:58 +01:00
longDescription = ''
Blightmud is a terminal client for connecting to Multi User Dungeon (MUD)
games. It is written in Rust and supports TLS, GMCP, MSDP, MCCP2, tab
completion, text searching and a split view for scrolling. Blightmud can
be customized with Lua scripting for aliases, triggers, timers, customized
status bars, and more. Blightmud supports several accessibility features
including an optional built-in text-to-speech engine and a screen reader
friendly mode.
'';
homepage = "https://github.com/Blightmud/Blightmud";
license = licenses.gpl3Plus;
maintainers = with maintainers; [ cpu ];
platforms = platforms.linux;
};
}
Reference in a new issue Copy permalink