llama - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #typescript #go #rust #macos #nodejs #windows #cli #kubernetes #vue #pytorch #openai #open-source

llama

(★ 52)

Luau Library for Immutable Data

파일 탐색기

최종 버전 다운로드 (.zip)

- - cd.yml
  - ci.yml
- run-lemur.lua
- run-tests.server.lua
- - installation.md
  - usage.md
- - favicon.ico
- api-reference.md
- index.md
- lemur
- testez
- - copy.lua
  - copyDeep.lua
  - count.lua
  - equals.lua
  - equalsDeep.lua
  - every.lua
  - filter.lua
  - flatten.lua
  - flip.lua
  - fromLists.lua
  - has.lua
  - includes.lua
  - init.lua
  - keys.lua
  - map.lua
  - merge.lua
  - mergeDeep.lua
  - removeKey.lua
  - removeKeys.lua
  - removeValue.lua
  - removeValues.lua
  - set.lua
  - some.lua
  - update.lua
  - values.lua
- - concat.lua
  - concatDeep.lua
  - copy.lua
  - copyDeep.lua
  - count.lua
  - create.lua
  - equals.lua
  - equalsDeep.lua
  - every.lua
  - filter.lua
  - find.lua
  - findLast.lua
  - findWhere.lua
  - findWhereLast.lua
  - first.lua
  - flatten.lua
  - includes.lua
  - init.lua
  - insert.lua
  - last.lua
  - map.lua
  - pop.lua
  - push.lua
  - reduce.lua
  - reduceRight.lua
  - removeIndex.lua
  - removeIndices.lua
  - removeValue.lua
  - removeValues.lua
  - reverse.lua
  - set.lua
  - shift.lua
  - slice.lua
  - some.lua
  - sort.lua
  - splice.lua
  - toSet.lua
  - unshift.lua
  - update.lua
  - zip.lua
  - zipAll.lua
- - add.lua
  - copy.lua
  - filter.lua
  - fromList.lua
  - has.lua
  - init.lua
  - intersection.lua
  - isSubset.lua
  - isSuperset.lua
  - map.lua
  - subtract.lua
  - toList.lua
  - union.lua
- equalObjects.lua
- init.lua
- isEmpty.lua
- None.lua
- t.lua
- - equalObjects.spec.lua
  - init.spec.lua
  - isEmpty.spec.lua
  - None.spec.lua
.gitignore
.gitmodules
CHANGELOG.md
default.project.json
foreman.toml
LICENSE
mkdocs.yml
README.md
roblox.toml
rotriever.toml
selene.toml
testez.toml
testing.project.json
wally.toml

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## ⚠️ No longer maintained ⚠️

**Alternatives**:
- [Sift](https://github.com/csqrl/sift)

---

Hello all! Since I do not do much Roblox game development these days (among other reasons), I will no longer be maintaining Llama.

Thank you to all of Llama's contributors, and I am verry sorry for any inconveniences I have caused.

If you have a good alternative to Llama, email me at llama@freddylist.xyz so I can link to it in this readme and archive Llama.

I recommend you ***do not fork*** Llama for these reasons:
- Runtime typechecking (present in Llama) is not really needed anymore with the advent of Luau type analysis.
- The tests are a bit of a mess.
- I'm sure Llama could've been designed better.
- Many other minor reasons...

If I do return to Roblox development in the future and no alternatives have been created yet, I may create a new immutable collections library. I will then hopefully have more experience with open-source projects and software development in general.

Thank you all again!

<h1 align="center">📚 Llama 🦙</h1>
<div align="center">
	<a href="https://github.com/freddylist/llama/actions"><img src="https://github.com/freddylist/llama/workflows/CI/badge.svg" alt="GitHub Actions Build Status" /></a>
	<a href="https://freddylist.github.io/llama"><img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" /></a>
</div>
<div align="center">
	Lua Library for Immutable Data
</div>

<div align="center">
	<img src="docs/img/favicon.ico" width=256 height=256 alt="Llama"></img>
</div>

## Installation

There are a few ways to get started with Llama.

### Method 1: Import model file

1. Download the `.rbxmx` model file from the latest release on the [Llama releases page](https://github.com/F-RDY/llama/releases).
2. Insert the model anywhere in a Roblox place!

### Method 2: Good ol' copy + paste

1. Copy the `src` directory of Llama into your project.
2. Rename it to `Llama`.
3. Make sure you put [`t`](https://github.com/osyrisrblx/t) under the Llama directory. (this step will hopefully be resolved in the future by package managers or Luau type-checking)
4. Use something like [Rojo](https://github.com/rojo-rbx/rojo) to sync your project to Roblox Studio!

### Method 3: Git submodule

1. Navigate to where you want to keep your submodules in Git bash.
2. Run `git submodule add https://github.com/F-RDY/llama.git`.
3. Using something like [Rojo](https://github.com/rojo-rbx/rojo), set up your project to sync `Llama/src` into Roblox Studio!

### Method 4: Package manager

*Coming Soon™*

## Usage

### Basic usage

To use Llama, simply require it as a module from where you installed it! It is also recommended that you set `Llama.Dictionary`, `Llama.List`, and `Llama.Set` to their own variables; otherwise, you'll be typing a lot!

```lua
-- Other modules...
local Llama = require(LlamaPath)

local Dictionary = Llama.Dictionary
local List = Llama.List
local Set = Llama.Set
```

### Usage with [Roact](https://github.com/Roblox/roact/) and [Rodux](https://github.com/Roblox/rodux)

Rodux requires your state to be immutable, so Llama is a great choice for manipulating it!

```lua
local function reducer(state, action)
	if action.type == "Add" then
		return Dictionary.merge(state, {
			counter = counter + 1
		})
	elseif action.type == "Subtract" then
		return Dictionary.merge(state, {
			counter = counter - 1
		})
	end
end
```

Visit the [docs](https://freddylist.github.io/llama/) for examples and API reference.

## Special Thanks

- [Mathilde](https://www.instagram.com/httpsugars_/) for the Llama icon
- [Llama's contributors](https://github.com/freddylist/llama/graphs/contributors)

## What's in a name?
Llamas are members of the Camelid group of mammals along with alpacas, camels, and dromedaries, which are known for being very stubborn but reliable animals.