pride_flags/README.txt

Pride Flags Mod v2.0.4
By Leslie E. Krause and Wuzzy

Pride Flags adds a variety of animated flags to celebrate Pride in Minetest.

This adds two blocks:

* Flag Pole: For the lower section
* Flag Pole with Flag: For the top of the flag pole with a flag attached.
                       Note: It occupies 3 blocks vertically.

Initially, the rainbow pride flag will appear when the Flag Pole with Flag is placed.
Use the 'place' or 'punch' key while pointing to the flag pole to select a different flag.

There are functions for programmers (see below) to add custom flags as well.

What are pride flags?
---------------------
Pride flags are flags created by LGBTQ+ people to represent themselves.
The rainbow flag is the most well-known flag and is understood as
the symbol for the whole LGBTQ+ community. Additionally, flags for
specific groups (like lesbian, bisexual, trans, etc.), exist, too.

Pride flags can be used by people in that community but also
by people outside of it to show support and acceptance, and to
spread awareness.

List of flags
--------------------
These flags are available:

* Orientations (sexual, romantic or other)
	* Gay/LGBTQ+ (rainbow flag)
	* Lesbian
	* Vincian
* Sexual orientations
	* Bisexual
	* Pansexual
	* Polysexual
	* Omnisexual
	* Asexual
	* Graysexual
	* Demisexual
* Romantic orientations
	* Homoromantic
	* Biromantic
	* Polyromantic
	* Panromantic
	* Omniromantic
	* Aromantic
	* Grayromantic
	* Demiromantic
* Gender-related
	* Genderqueer
	* Transgender
	* Androgyne
	* Demigender
	* Maverique
	* Neutrois
	* Multigender
	* Polygender
	* Pangender
	* Agender
	* Genderfluid
* Sex-related
	* Intersex
* Relationships
	* Polyamorous
* Queer
	* Queer

API (for programmers)
----------------------
This mod has a few helper functions if you're a programmer and want to interface with it.
You can add custom flags and more. See `API.md` for a list of all functions.

Repository
----------------------

Browse source code...
  https://codeberg.org/Wuzzy/pride_flags

Compatability
----------------------

Minetest 5.4.0 or later required.

(older versions might work, too, but the flag waving sound is buggy)

Installation
----------------------

  1) Unzip the archive into the mods directory of your game.
  2) Rename the pride_flags-master directory to "pride_flags".

Source Code License
----------------------------------------------------------

GNU Lesser General Public License v3 (LGPL-3.0)

Copyright (c) 2022, Leslie E. Krause <leslie@searstower.org> and Wuzzy <Wuzzy@disroot.org>

This program is free software; you can redistribute it and/or modify it under the terms of
the GNU Lesser General Public License as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Lesser General Public License for more details.

http://www.gnu.org/licenses/lgpl-3.0.html


Multimedia License (textures, sounds, and models)
----------------------------------------------------------

Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)

   /models/pride_flags_mast_lower.obj
   by sorcerykid

   /models/pride_flags_mast_upper.obj
   by sorcerykid

   /models/pride_flags_wavingflag.b3d
   by sorcerykid

   /textures/pride_flags_baremetal.png
   by sorcerykid

   /sounds/pride_flags_flagwave1.ogg
   by Chelly01
   obtained from https://freesound.org/people/Chelly01/sounds/541088/
   modified by sorcerykid

   /sounds/pride_flags_flagwave2.ogg
   by Chelly01
   obtained from https://freesound.org/people/Chelly01/sounds/541088/
   modified by sorcerykid

   /sounds/pride_flags_flagwave3.ogg
   by Chelly01
   obtained from https://freesound.org/people/Chelly01/sounds/541088/
   modified by sorcerykid

   Pride flags:
   All pride flags have a name like "/textures/prideflag_<NAME>.png",
   where <NAME> is the pride flag name. For example, the rainbow flag
   is "/textures/prideflag_rainbow.png". These are the current pride flags:

   asexual, bisexual, rainbow, gendercreative, genderfluid, genderqueer,
   lesbian, nonbinary, pansexual, polysexual, transgender:
   by sorcerykid

   aromantic, grayromantic, demiromantic, graysexual, demisexual, omnisexual,
   homoromantic, biromantic, panromantic, polyromantic, omniromantic,
   vincian, agender, demigender, androgyne, multigender,
   intersex, polyamorous, queer, maverique, neutrois, multigender, polygender:
   by Wuzzy

You are free to:
Share — copy and redistribute the material in any medium or format.
Adapt — remix, transform, and build upon the material for any purpose, even commercially.
The licensor cannot revoke these freedoms as long as you follow the license terms.

Under the following terms:

Attribution — You must give appropriate credit, provide a link to the license, and
indicate if changes were made. You may do so in any reasonable manner, but not in any way
that suggests the licensor endorses you or your use.

No additional restrictions — You may not apply legal terms or technological measures that
legally restrict others from doing anything the license permits.

Notices:

You do not have to comply with the license for elements of the material in the public
domain or where your use is permitted by an applicable exception or limitation.
No warranties are given. The license may not give you all of the permissions necessary
for your intended use. For example, other rights such as publicity, privacy, or moral
rights may limit how you use the material.

For more details:
http://creativecommons.org/licenses/by-sa/3.0/